You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@types/graceful-fs

Package Overview
Dependencies
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/graceful-fs

TypeScript definitions for graceful-fs


Version published
Weekly downloads
21M
increased by0.32%
Maintainers
1
Created
Weekly downloads
 

Package description

What is @types/graceful-fs?

@types/graceful-fs provides TypeScript type definitions for the graceful-fs package, which is a drop-in replacement for the native Node.js fs module with improvements to handle EMFILE errors (too many open files) gracefully.

What are @types/graceful-fs's main functionalities?

Reading Files

This feature allows you to read the contents of a file asynchronously. The graceful-fs package ensures that the operation handles too many open files errors gracefully.

const fs = require('graceful-fs');
fs.readFile('example.txt', 'utf8', (err, data) => {
  if (err) throw err;
  console.log(data);
});

Writing Files

This feature allows you to write data to a file asynchronously. The graceful-fs package ensures that the operation handles too many open files errors gracefully.

const fs = require('graceful-fs');
fs.writeFile('example.txt', 'Hello, world!', (err) => {
  if (err) throw err;
  console.log('File has been saved!');
});

Appending to Files

This feature allows you to append data to a file asynchronously. The graceful-fs package ensures that the operation handles too many open files errors gracefully.

const fs = require('graceful-fs');
fs.appendFile('example.txt', 'Appending some text.', (err) => {
  if (err) throw err;
  console.log('Text has been appended!');
});

Deleting Files

This feature allows you to delete a file asynchronously. The graceful-fs package ensures that the operation handles too many open files errors gracefully.

const fs = require('graceful-fs');
fs.unlink('example.txt', (err) => {
  if (err) throw err;
  console.log('File has been deleted!');
});

Other packages similar to @types/graceful-fs

Readme

Source

Installation

npm install --save @types/graceful-fs

Summary

This package contains type definitions for graceful-fs (https://github.com/isaacs/node-graceful-fs).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/graceful-fs.

index.d.ts

/// <reference types="node" />

export * from "fs";

/**
 * Use this method to patch the global fs module (or any other fs-like module).
 * NOTE: This should only ever be done at the top-level application layer, in order to delay on
 * EMFILE errors from any fs-using dependencies. You should **not** do this in a library, because
 * it can cause unexpected delays in other parts of the program.
 * @param fsModule The reference to the fs module or an fs-like module.
 */
export function gracefulify<T>(fsModule: T): T;

Additional Details

  • Last updated: Tue, 07 Nov 2023 03:09:37 GMT
  • Dependencies: @types/node

Credits

These definitions were written by Bart van der Schoor, and BendingBender.

FAQs

Package last updated on 07 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc