UNPKG

1.24 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/graceful-fs`
3
4# Summary
5This package contains type definitions for graceful-fs (https://github.com/isaacs/node-graceful-fs).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/graceful-fs.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/graceful-fs/index.d.ts)
10````ts
11/// <reference types="node" />
12
13export * from "fs";
14
15/**
16 * Use this method to patch the global fs module (or any other fs-like module).
17 * NOTE: This should only ever be done at the top-level application layer, in order to delay on
18 * EMFILE errors from any fs-using dependencies. You should **not** do this in a library, because
19 * it can cause unexpected delays in other parts of the program.
20 * @param fsModule The reference to the fs module or an fs-like module.
21 */
22export function gracefulify<T>(fsModule: T): T;
23
24````
25
26### Additional Details
27 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
28 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
29
30# Credits
31These definitions were written by [Bart van der Schoor](https://github.com/Bartvds), and [BendingBender](https://github.com/BendingBender).
32
\No newline at end of file