Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
@react-native-windows/fs
Advanced tools
Readme
@react-native-windows/fs
is a minimal-dependency drop-in replacement to fs
with changes for
resiliency, promises, and convenience. It has several opinionated changes, targeted towards CLI
applications handling JavaScript-oriented files.
@react-native-windows/fs
exposes a Promise-based API, mostly matching that of fs.promises
, with
several methods added extra methods.
// import {promises as fs} from 'fs'
import fs from '@react-native-windows/fs';
const fileContent = await fs.readFile('foo.txt');
@react-native-windows/fs
exports all fs.*Sync
Where an async version has a graceful
implementation, and the synchronous version does not, the method is marked as deprecated.
// import fs from 'fs'
import fs from '@react-native-windows/fs';
const fileContent = fs.readFileSync('foo.txt');
exists
NodeJS deprecated fs.exists
, and removed fs.promises.exists
. The recommendation is to instead
acquire a lock to the file via fs.open
for the duration of file-use. One-shot existence checks are
still useful, and because fs.existsSync
is not deprecated, more likely means usage of blocking
synchronous APIs.
import fs from '@react-native-windows/fs';
const fooExists = await fs.exists('foo.txt');
readJsonFile
and readJsonFileSync
@react-native-windows/fs
provides convenience methods to handle JSON files. The following methods
are added:
Method | Return type |
---|---|
readJsonFile<T> | Promise<T> or Promise<Record<string, unknown>> |
readJsonFileSync<T> | T or Record<string, unknown> |
import fs from '@react-native-windows/fs';
// foo is type: Record<string, unknown> by default
const foo = await fs.readJsonFile('foo.json');
// foo is type: FooProps
type FooProps = { name: string, version: string };
const foo = await fs.readJsonFile<FooProps>('foo.json');
@react-native-windows/fs
uses graceful-fs
to
gracefully handle transient filesystem conditions, at the cost of extra latency. This includes
transient EPERM
, EACCESS
, EMFILE
, ENFILE
. This can be important when handling files that a
subject to antivirus, which may temporarily lock mutation of files on Windows.
We reccomend adding the following rules to your eslint config if you would like to use
@react-native-windows/fs
everywhere:
module.exports = {
rules: {
'no-restricted-imports': [
'error', {
name: 'fs',
message: 'Please use `@react-native-windows/fs` instead of `fs`'
}
],
}
}
FAQs
A minimal-dependency drop-in replacement to `fs` with changes for resiliency, promises, and convenience.
We found that @react-native-windows/fs demonstrated a healthy version release cadence and project activity because the last version was released less than 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
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).