From 5e69fad30b5207a5d6600c336816c6889511f24c Mon Sep 17 00:00:00 2001 From: Stephen Cresswell <229672+cressie176@users.noreply.github.com> Date: Sat, 26 Aug 2023 18:51:18 +0100 Subject: [PATCH] Improve README (maybe) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 809209f..710e97e 100644 --- a/README.md +++ b/README.md @@ -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)
[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)
[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