https://github.com/cloudcmd/node-read-files-sync
synchronously read files from a directory
https://github.com/cloudcmd/node-read-files-sync
cloudcmd directory file read
Last synced: 10 months ago
JSON representation
synchronously read files from a directory
- Host: GitHub
- URL: https://github.com/cloudcmd/node-read-files-sync
- Owner: cloudcmd
- License: mit
- Created: 2018-03-05T10:38:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-16T19:49:35.000Z (over 6 years ago)
- Last Synced: 2025-03-17T21:34:41.929Z (11 months ago)
- Topics: cloudcmd, directory, file, read
- Language: JavaScript
- Size: 11.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# Read Files Sync [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
Synchronously read files from a directory.
## Install
```
npm i @cloudcmd/read-files-sync
```
## readFilesSync(path[, mode])
- `path` **string** - path to a directory
- `mode` **string** - mode
```js
const readFilesSync = require('@cloudcmd/read-files-sync');
readFilesSync('./fixture', 'utf8');
// returns
{
a: 'hello',
b: 'world',
}
```
## readFilesSync(path[, names, mode])
- `path` **string** - path to a directory
- `names` **array** - file names to read
- `mode` **string** - mode
```js
readFilesSync('./fixture', ['a'], 'utf8');
// returns
{
a: 'hello',
}
```
## Related
- [fs-copy-file](https://github.com/coderaiser/fs-copy-file "fs-copy-file") - Asynchronously copies src to dest.
- [fs-copy-file-sync](https://github.com/coderaiser/fs-copy-file-sync "fs-copy-file-sync") - Synchronously copies src to dest.
## License
MIT
[NPMIMGURL]: https://img.shields.io/npm/v/@cloudcmd/read-files-sync.svg?style=flat
[BuildStatusIMGURL]: https://img.shields.io/travis/cloudcmd/node-read-files-sync/master.svg?style=flat
[DependencyStatusIMGURL]: https://img.shields.io/david/cloudcmd/node-read-files-sync.svg?style=flat
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]: https://coveralls.io/repos/cloudcmd/node-read-files-sync/badge.svg?branch=master&service=github
[NPMURL]: https://npmjs.org/package/@cloudcmd/read-files-sync "npm"
[BuildStatusURL]: https://travis-ci.org/cloudcmd/node-read-files-sync "Build Status"
[DependencyStatusURL]: https://david-dm.org/cloudcmd/node-read-files-sync "Dependency Status"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]: https://coveralls.io/github/cloudcmd/node-read-files-sync?branch=master