UNPKG

1.3 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/shimmer`
3
4# Summary
5This package contains type definitions for shimmer (https://github.com/othiym23/shimmer).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shimmer.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shimmer/index.d.ts)
10````ts
11declare const shimmer: {
12 (options: { logger?(msg: string): void }): void;
13 wrap<Nodule extends object, FieldName extends keyof Nodule>(
14 nodule: Nodule,
15 name: FieldName,
16 wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
17 ): void;
18 massWrap<Nodule extends object, FieldName extends keyof Nodule>(
19 nodules: Nodule[],
20 names: FieldName[],
21 wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
22 ): void;
23 unwrap<Nodule extends object>(
24 nodule: Nodule,
25 name: keyof Nodule,
26 ): void;
27 massUnwrap<Nodule extends object>(
28 nodules: Nodule[],
29 names: Array<keyof Nodule>,
30 ): void;
31};
32
33export = shimmer;
34
35````
36
37### Additional Details
38 * Last updated: Mon, 08 Jul 2024 08:09:26 GMT
39 * Dependencies: none
40
41# Credits
42These definitions were written by [Kelvin Jin](https://github.com/kjin).
43
\No newline at end of file