Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
The fstream npm package is a Node.js module that provides advanced file system operations through readable and writable streams. It allows for reading from and writing to files in a highly efficient, streaming manner, which is particularly useful for handling large files or performing file manipulations without loading entire files into memory.
Reading files
This feature allows you to read data from a file in chunks. The 'data' event is emitted each time a chunk of data is read from the file, making it suitable for processing large files without excessive memory usage.
const fstream = require('fstream');
const reader = fstream.Reader('path/to/file.txt');
reader.on('data', function(chunk) {
console.log('Read some data:', chunk);
});
Writing files
This feature enables writing data to a file. You can write chunks of data to the file, and call 'end' when no more data needs to be written. This is useful for generating files on-the-fly or appending data to existing files.
const fstream = require('fstream');
const writer = fstream.Writer('path/to/output.txt');
writer.write('Hello, world!\n');
writer.end();
Piping between streams
This demonstrates the ability to pipe data directly from a readable stream to a writable stream, which is a powerful feature for efficiently transferring data without intermediate storage.
const fstream = require('fstream');
const reader = fstream.Reader('path/to/input.txt');
const writer = fstream.Writer('path/to/output.txt');
reader.pipe(writer);
fs-extra builds upon the native fs module, providing additional file system methods not found in the standard library. It offers similar file manipulation capabilities but does not focus exclusively on stream-based operations like fstream.
graceful-fs enhances the fs module by adding features to improve robustness and error handling. It is similar to fstream in that it deals with file system operations but does not specifically provide streaming interfaces.
Like FS streams, but with stat on them, and supporting directories and symbolic links, as well as normal files. Also, you can use this to set the stats on a file, even if you don't change its contents, or to create a symlink, etc.
So, for example, you can "write" a directory, and it'll call mkdir
. You
can specify a uid and gid, and it'll call chown
. You can specify a
mtime
and atime
, and it'll call utimes
. You can call it a symlink
and provide a linkpath
and it'll call symlink
.
Note that it won't automatically resolve symbolic links. So, if you
call fstream.Reader('/some/symlink')
then you'll get an object
that stats and then ends immediately (since it has no data). To follow
symbolic links, do this: fstream.Reader({path:'/some/symlink', follow: true })
.
There are various checks to make sure that the bytes emitted are the same as the intended size, if the size is set.
fstream
.Writer({ path: "path/to/file"
, mode: 0755
, size: 6
})
.write("hello\n")
.end()
This will create the directories if they're missing, and then write
hello\n
into the file, chmod it to 0755, and assert that 6 bytes have
been written when it's done.
fstream
.Writer({ path: "path/to/file"
, mode: 0755
, size: 6
, flags: "a"
})
.write("hello\n")
.end()
You can pass flags in, if you want to append to a file.
fstream
.Writer({ path: "path/to/symlink"
, linkpath: "./file"
, SymbolicLink: true
, mode: "0755" // octal strings supported
})
.end()
If isSymbolicLink is a function, it'll be called, and if it returns
true, then it'll treat it as a symlink. If it's not a function, then
any truish value will make a symlink, or you can set type: 'SymbolicLink'
, which does the same thing.
Note that the linkpath is relative to the symbolic link location, not the parent dir or cwd.
fstream
.Reader("path/to/dir")
.pipe(fstream.Writer("path/to/other/dir"))
This will do like cp -Rp path/to/dir path/to/other/dir
. If the other
dir exists and isn't a directory, then it'll emit an error. It'll also
set the uid, gid, mode, etc. to be identical. In this way, it's more
like rsync -a
than simply a copy.
FAQs
Advanced file system stream things
The npm package fstream receives a total of 2,564,533 weekly downloads. As such, fstream popularity was classified as popular.
We found that fstream demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
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.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.