destroy 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|
The destroy npm package is designed to ensure that a stream gets destroyed efficiently, accommodating different APIs and handling specific Node.js bugs. This potent tool is central to creating clean and high-performing Node.js applications as it allows you to dismantle a stream when it is no longer needed, freeing up system resources.
Utilizing the destroy package in your code is fairly straightforward. Begin by installing the package using your preferred package manager. The following example demonstrates how to use the destroy function in a Node.js application:
var destroy = require('destroy') // First, require the package
var fs = require('fs') // Require the file system module
var stream = fs.createReadStream('package.json') // Create a read stream
// ... and when the stream is no longer needed
destroy(stream) // Destroy the stream
In this example, destroy is called, passing the stream object as an argument. Depending on the stream's type, destroy applies the appropriate method to ensure the stream is destroyed without any leaks.
The complete documentation for the destroy function can primarily be found in its GitHub repository at https://github.com/stream-utils/destroy.git. The README.md file available in the repository provides substantive details about the package, its use cases, and the API, including how different types of streams are handled.
