https://github.com/bevry-archive/file

Deprecated: Use `@bevry/fs-*` packages instead
https://github.com/bevry-archive/file

Last synced: about 10 hours ago
JSON representation

Deprecated: Use `@bevry/fs-*` packages instead

• Host: GitHub
• URL: https://github.com/bevry-archive/file
• Owner: bevry-archive
• License: other
• Created: 2021-07-29T16:06:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-30T16:24:53.000Z (10 months ago)
• Last Synced: 2024-04-13T10:07:46.922Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 379 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


@bevry/file


































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

## Usage

[Complete API Documentation.](http://main.file.bevry.surge.sh/docs/)

## Alternatives

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

-   [@bevry/fs-accessible](https://github.com/bevry/fs-accessible)

-   [@bevry/fs-executable](https://github.com/bevry/fs-executable)

-   [@bevry/fs-list](https://github.com/bevry/fs-list)

-   [@bevry/fs-mkdirp](https://github.com/bevry/fs-mkdirp)

-   [@bevry/fs-read](https://github.com/bevry/fs-read)

-   [@bevry/fs-readable](https://github.com/bevry/fs-readable)

-   [@bevry/fs-remove](https://github.com/bevry/fs-remove)

-   [@bevry/fs-rmdir](https://github.com/bevry/fs-rmdir)

-   [@bevry/fs-unlink](https://github.com/bevry/fs-unlink)

-   [@bevry/fs-write](https://github.com/bevry/fs-write)

-   [@bevry/fs-writable](https://github.com/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


``` html

    import * as pkg from '//cdn.skypack.dev/@bevry/file@^2.3.0'

```

unpkg


``` html

    import * as pkg from '//unpkg.com/@bevry/file@^2.3.0'

```

jspm


``` html

    import * as pkg from '//dev.jspm.io/@bevry/[email protected]'

```

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


```

```