WIP better generated API reference docs
This commit is contained in:
24
docs/reference/api/Client.md
Normal file
24
docs/reference/api/Client.md
Normal file
@ -0,0 +1,24 @@
|
||||
## `Client`
|
||||
|
||||
### Constructor
|
||||
|
||||
:::
|
||||
new Client(opts: [ClientOptions](./ClientOptions.md));
|
||||
:::
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Description |
|
||||
| - | - | - |
|
||||
| `connectionPool` | [BaseConnectionPool](./BaseConnectionPool.md) | |
|
||||
| `diagnostic` | [Diagnostic](./Diagnostic.md) | |
|
||||
| `helpers` | [Helpers](./Helpers.md) | |
|
||||
| `name` | string | symbol | |
|
||||
| `serializer` | [Serializer](./Serializer.md) | |
|
||||
| `transport` | [SniffingTransport](./SniffingTransport.md) | |
|
||||
|
||||
### Methods
|
||||
|
||||
| Name | Signature | Description |
|
||||
| - | - | - |
|
||||
| `child` | `child(opts: [ClientOptions](./ClientOptions.md)): [Client](./Client.md);` | Creates a child client instance that shared its connection pool with the parent client || `close` | `close(): Promise<void>;` | Closes all connections in the connection pool. Connections shared with any parent or child instances will also be closed. |
|
||||
Reference in New Issue
Block a user