Skip to content

Commit

Permalink
Update .d.ts and docs
Browse files Browse the repository at this point in the history
Closes: #221
Refs: #271
PR-URL: #273
  • Loading branch information
tshemsedinov committed Dec 17, 2024
1 parent 0521125 commit 6e3ffd8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ Async collection is an utility to collect needed keys and signalize on done.
- `options.reassign?: boolean`
- `options.defaults?: object`
- `options.validate?: (data: Record<string, unknown>) => unknown`
- `set(key: string, value: unknown)`
- `wait(key: string, fn: AsyncFunction | Promise<unknown>, ...args?: Array<unknown>)`
- `take(key: string, fn: Function, ...args?: Array<unknown>)`
- `collect(sources: Record<string, Collector>)`
- `fail(error: Error)`
- `abort()`
- `then(onFulfill: Function, onReject?: Function)`
- `set(key: string, value: unknown): void`
- `wait(key: string, fn: AsyncFunction | Promise<unknown>, ...args?: Array<unknown>): void`
- `take(key: string, fn: Function, ...args?: Array<unknown>): void`
- `collect(sources: Record<string, Collector>): void`
- `fail(error: Error): void`
- `abort(): void`
- `then(onFulfilled: Function, onRejected?: Function): Promise<unknown>`
- `done: boolean`
- `data: Dictionary`
- `keys: Array<string>`
Expand Down Expand Up @@ -378,11 +378,11 @@ console.log({ size, bytes });

- `getMaxListeners(): number`
- `listenerCount(name: string): number`
- `on(name: string, fn: Function)`
- `once(name: string, fn: Function)`
- `emit(name: string, ...args: Array<unknown>)`
- `remove(name: string, fn: Function)`
- `clear(name: string)`
- `on(name: string, fn: Function): void`
- `once(name: string, fn: Function): void`
- `emit(name: string, ...args: Array<unknown>): void`
- `remove(name: string, fn: Function): void`
- `clear(name: string): void`

## `EventEmitter` utilities

Expand Down
2 changes: 1 addition & 1 deletion metautil.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ export class Collector {
collect(sources: Record<string, Collector>): void;
fail(error: Error): void;
abort(): void;
then(onFulfill: Function, onReject?: Function): Promise<unknown>;
then(onFulfilled: Function, onRejected?: Function): Promise<unknown>;
}

export function collect(
Expand Down

0 comments on commit 6e3ffd8

Please sign in to comment.