Skip to content

Commit

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

| Generic Pool | X-Pool | Notes |
| ------------------ | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| acquire | [acquire](#acquire--promiset) | 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](#releaseresource-t--void) | Releasing resources is a synchronous operation hence the method does not return a promise |
| destroy | [destroy](#destroy--void)<br/>[evictBadResources](#evictbadresources--void) | Resources are destroyed in the background hence the method does not return a promise. If destroying a resource fails it will count towards the maximum pool size until evicted |
| acquire | [acquire](#acquire--promiset) | X-Pool does not currently support priorities. If you need this feature please raise a ticket. |
| isBorrowedResource | Not Supported | This method is not necessary since returning an unmanaged resource to the pool will have no effect. |
| release | [release](#releaseresource-t--void) | Releasing resources is a synchronous operation hence the method does not return a promise. |
| destroy | [destroy](#destroy--void)<br/>[evictBadResources](#evictbadresources--void) | Resources are destroyed in the background hence the method does not return a promise. If destroying a resource fails it will count towards the maximum pool size until evicted. |
| start | [initialise](#initialise--promisevoid) | 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. |
| ready | Not Supported | Await the initialise method or listen for the InitialisePoolOperation.SUCCEEDED event. |
| use | [with](#withresource--t--promise--promise) | |
| drain | [shutdown](#shutdown--promisevoid) | |
| clear | Not Supported | Not necessary with X-Pool |
| stats | [stats](#stats--poolstats) | See [Pool stats](#pool-stats) |
| stats | [stats](#stats--poolstats) | See [Pool stats](#pool-stats). |

### Events

Expand Down

0 comments on commit 5e69fad

Please sign in to comment.