Package Exports
- @wessberg/fileloader
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wessberg/fileloader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A Promise-based class that can offers different ways of loading files from disk, including wrappers around the synchronous I/O methods from node.
Description
DISCLAIMER
This library will be deprecated. There are better alternatives built directly
into the fs module now. Use that instead.
Table of Contents
Install
npm
$ npm install @wessberg/fileloaderYarn
$ yarn add @wessberg/fileloaderpnpm
$ pnpm add @wessberg/fileloaderUsage
const fileLoader = new FileLoader();
// Just a simple Promise-based async I/O method.
const buffer = await fileLoader.load("some_file.ts");
// A wrapper around the "readSync" method from node's "fs" module.
const sync = fileLoader.loadSync("some_file.ts");
// Loads the first matched file associated with the given path
// combined with the given array of ordered extensions.
const [result, path] = await fileLoader.loadWithFirstMatchedExtension("some_path", [".ts", ".fs"]);
// Loads all files in the given directory.
const buffers = await fileLoader.loadAllInDirectory("some_dir");
// Gets a list of all files in the given directory with an extension of "ts".
const buffers = await fileLoader.getFilesInDirectory("some_dir", [".ts"]);Contributing
Do you want to contribute? Awesome! Please follow these recommendations.
Maintainers
 |
|---|
| Frederik Wessberg Twitter: @FredWessberg Github: @wessberg Lead Developer |
Backers
Patreon
Become a backer and get your name, avatar, and Twitter handle listed here.
License
MIT © Frederik Wessberg (@FredWessberg) (Website)