@bevry/file

Helpers for reading, writing, deleting, and accessing a file.

Usage

Complete API Documentation.

Alternatives

You should use these instead, which use and provide modern APIs while providing brilliant ecosystem support:

• @bevry/fs-accessible
• @bevry/fs-executable
• @bevry/fs-list
• @bevry/fs-mkdirp
• @bevry/fs-read
• @bevry/fs-readable
• @bevry/fs-remove
• @bevry/fs-rmdir
• @bevry/fs-unlink
• @bevry/fs-write
• @bevry/fs-writable

Install

npm

• Install: npm install --save @bevry/file
• Import: import * as pkg from ('@bevry/file')
• Require: const pkg = require('@bevry/file')

Skypack

<script type="module">
    import * as pkg from '//cdn.skypack.dev/@bevry/file@^2.3.0'
</script>

unpkg

<script type="module">
    import * as pkg from '//unpkg.com/@bevry/file@^2.3.0'
</script>

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/@bevry/file@2.3.0'
</script>

Editions

This package is published with the following editions:

• @bevry/file aliases @bevry/file/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
• @bevry/file/source/index.ts is TypeScript source code with Import for modules
• @bevry/file/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• @bevry/file/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 14 || 16 || 18 || 20 || 21 with Require for modules
• @bevry/file/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• @bevry/file/edition-es2016/index.js is TypeScript compiled against ES2016 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• @bevry/file/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• @bevry/file/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2020+ Benjamin Lupton

and licensed under:

• Artistic License 2.0