Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update example to ESM + improve API docs #5

Merged
merged 1 commit into from
Feb 7, 2024
Merged

docs: update example to ESM + improve API docs #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ npm i @autotelic/fastify-queue
#### Example

```js
const fastifyQueue = require('@autotelic/fastify-queue')
import fastifyQueue from '@autotelic/fastify-queue'

function myRoute (fastify, opts) {
fastify.register(fastifyQueue)
Expand All @@ -31,16 +31,16 @@ function myRoute (fastify, opts) {

fastify-queue accepts the following *optional* configuration:

- #### `initializer`: `(key: string, value: any, reply: FastifyReply) => any | Promise<any>`
- #### `initializer`: `(key: PropertyKey, value: unknown, reply: FastifyReply) => unknown | Promise<unknown>`
- Called each time an item is added to the queue. The value returned will be the value added to the queue.

- #### `resolver`: `(key: string, value: any, reply: FastifyReply) => any`
- #### `resolver`: `(key: PropertyKey, value: unknown, reply: FastifyReply) => unknown | PromiseLike<unknown>`
- Called each time an item in the queue is resolved. `value` is the resolved value of an item in the queue.

- #### `onError`: `(error: Error, reply: FastifyReply) => any`
- #### `onError`: `(error: Error, reply: FastifyReply) => void`
- Called if an error occurs while resolving the queue. Defaults to `fastify.log.error(error)`.

- #### `onResolved`: `(result: any, reply: FastifyReply) => void`
- #### `onResolved`: `(result: Map<PropertyKey, unknown>, reply: FastifyReply) => void | Promise<void>`
- Called after the queue has successfully resolved. `result` is the resolved queue.

- #### `queueName`: `string`
Expand All @@ -59,12 +59,14 @@ fastify-queue accepts the following *optional* configuration:

fastify-queue adds a `queue` (or the value of `opts.queueName`) reply decorator containing the following properties:

- #### `add`: `(key: string, value: any) => void`
- #### `add`: `(key: PropertyKey, value: unknown) => void`
- Used to add items to the queue.

- #### `resolve`: `(cb?: (result: any, reply: FastifyReply) => void) => void`
- Used to manually resolve the queue. `cb` defaults to `opts.onResolved`.
- #### `resolve`: `(cb?: typeof opts.onResolved) => Promise<void>`
- Used to manually resolve the queue. `cb` defaults to `opts.onResolved`
- If `cb` is provided it will be called instead of `opts.onResolved`
- `result` param of `cb` is the resolved queue
- fastify-queue will automatically resolve the queue in an `onResponse` hook, if this has not already been called.

- #### `contents`: `Map`
- #### `contents`: `Map<PropertyKey, unknown>`
- The queue `Map` instance.