Skip to content

Commit

Permalink
remove empty agent file and add Client links to Pool doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Ethan-Arrowood committed Feb 24, 2021
1 parent fc8bdb1 commit 7b1542b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 8 deletions.
Empty file removed docs/Agent.md
Empty file.
43 changes: 35 additions & 8 deletions docs/Pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Arguments:

Extends: [`ClientOptions`](./Client.md#parameter-clientoptions)

* **connections** `number | null` (optional) - Default: `null` - The number of `Client` instances to create.
* **connections** `number | null` (optional) - Default: `null` - The number of `Client` instances to create. When set to `null`, the `Pool` instance will create an unlimited amount of `Client` instances.

## Instance Properties

Expand All @@ -41,6 +41,11 @@ Implements [Client.destroyed](./Client.md#clientdestroyed)

Implements [Client.pending](./Client.md#clientpending)

<!-- TODO: https://github.com/nodejs/undici/issues/561
### `Pool.pipelining`
Implements [Client.pipelining](./Client.md#clientpipelining) -->

### `Pool.running`

Implements [Client.running](./Client.md#clientrunning)
Expand All @@ -57,24 +62,46 @@ Implements [Client.url](./Client.md#clienturl)

### `Pool.close(callback)`

### `Pool.connect(options, handler)`
Implements [`Client.close([ callback ])`](./Client.md#clientclose-callback-)

### `Pool.connect(options [, callback])`

Implements [`Client.connect(options [, callback])`](./Client.md#clientconnectoptions--callback)

### `Pool.destroy(error, callback)`
### `Pool.destroy(error)`

### `Pool.dispatch(options, handler)`
Implements [`Client.destroy(error)`](./Client.md#clientdestroyerror)

### `Pool.dispatch(options, handlers)`

Implements [`Client.dispatch(options, handlers)`](./Client.md#clientdispatchoptions-handlers)

### `Pool.pipeline(options, handler)`

### `Pool.request(options, handler)`
Implements [`Client.pipeline(options, handler)`](./Client.md#clientpipelineoptions-handler)

### `Pool.request(options [, callback])`

### `Pool.stream(options, handler)`
Implements [`Client.request(options [, callback])`](./Client.md#clientrequestoptions--callback)

### `Pool.upgrade(options, handler)`
### `Pool.stream(options, factory, [, callback])`

Implements [`Client.stream(options, factory [, callback])`](./Client.md#clientstreamoptions-factory--callback)

### `Pool.upgrade(options [, callback])`

Implements [`Client.upgrade(options[, callback])`](./Client.md#clientupgradeoptions-callback)

## Instance Events

### Event: `'connect'`

Implements [Client Event: `'connect'`](./Client.md#event-connect)

### Event: `'disconnect'`

### Event: `'drain'`
Implements [Client Event: `'disconnect'`](./Client.md#event-connect)

### Event: `'drain'`

Implements [Client Event: `'drain'`](./Client.md#event-connect)

0 comments on commit 7b1542b

Please sign in to comment.