Skip to content

Commit

Permalink
Improve README (maybe)
Browse files Browse the repository at this point in the history
  • Loading branch information
@cressie176
cressie176 committed Aug 26, 2023
1 parent 0e09dff commit 11d1295
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,17 +308,17 @@ Migrating from [generic-pool](https://github.com/coopernurse/node-pool) is relat

### API

| Generic Pool | X-Pool | Notes |
| ------------------ | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| acquire | acquire() : Promise<T> | X-Pool does not currently support priorities |
| isBorrowedResource | Not Supported | This method is not necessary since returning an unmanaged resource to the pool will have no effect |
| release | release(resource : T) : void | Releasing resources is a synchronous operation hence the method does not return a promise |
| destroy | destroy(resource : T) : void | Resources are destroyed in the background hence the method does not return a promise |
| start | initialise() : Promise<void> | Resolves once the minimum number of resources have been added to the pool, or rejects if the optional `initialiseTimeout` is exceeded. You do not need to wait for the initialise method to resolve if you do not want to. |
| ready | Not Supported | Await the initialise method instead. |
| Generic Pool | X-Pool | Notes |
| ------------------ | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| acquire | acquire() : Promise<T> | X-Pool does not currently support priorities |
| isBorrowedResource | Not Supported | This method is not necessary since returning an unmanaged resource to the pool will have no effect |
| release | release(resource : T) : void | Releasing resources is a synchronous operation hence the method does not return a promise |
| destroy | destroy(resource : T) : void | Resources are destroyed in the background hence the method does not return a promise |
| start | initialise() : Promise<void> | Resolves once the minimum number of resources have been added to the pool, or rejects if the optional `initialiseTimeout` is exceeded. You do not need to wait for the initialise method to resolve if you do not want to. |
| ready | Not Supported | Await the initialise method instead. |
| use | with((resource: T) => Promise<any>) : Promise<any> | |
| drain | shutdown() : Promise<void> | |
| clear | Not Supported | Not necessary with X-Pool |
| drain | shutdown() : Promise<void> | |
| clear | Not Supported | Not necessary with X-Pool |

### Events

Expand Down

0 comments on commit 11d1295

Please sign in to comment.