@stdlib/fs-read-file-list

Read the entire contents of each file in a file list.

https://github.com/stdlib-js/fs-read-file-list

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.7%) to scientific vocabulary

Keywords

async concurrent file filesystem fs javascript list multiple node node-js nodejs open parallel path read readfile readfilesync stdlib sync

Last synced: 4 months ago · JSON representation ·

Repository

Read the entire contents of each file in a file list.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.27 MB

Statistics

Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

async concurrent file filesystem fs javascript list multiple node node-js nodejs open parallel path read readfile readfilesync stdlib sync

Created over 4 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Read File List

Read the entire contents of each file in a file list.

## Installation ```bash npm install @stdlib/fs-read-file-list ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). - To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally. The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var readFileList = require( '@stdlib/fs-read-file-list' ); ``` #### readFileList( filepaths\[, options], clbk ) Asynchronously reads the entire contents of each file in a file list. ```javascript readFileList( [ __filename ], onFiles ); function onFiles( error, files ) { if ( error ) { throw error; } console.dir( files ); // => [{...}] } ``` Each file is represented by an `object` with the following fields: - **file**: file path. - **data**: file contents as either a [`Buffer`][node-buffer] or `string`. The function accepts the same options as [`readFile()`][@stdlib/fs/read-file]. #### readFileList.sync( filepaths\[, options] ) Synchronously reads the entire contents of each file in a file list. ```javascript var out = readFileList.sync( [ __filename ] ); if ( out instanceof Error ) { throw out; } console.dir( out ); // => [{...}] ``` The function accepts the same options as [`readFile.sync()`][@stdlib/fs/read-file].

## Examples ```javascript var readFileList = require( '@stdlib/fs-read-file-list' ); /* Sync */ var files = readFileList.sync( [ __filename ], 'utf8' ); // returns console.log( files instanceof Error ); // => false files = readFileList.sync( [ 'beepboop' ], { 'encoding': 'utf8' }); // returns console.log( files instanceof Error ); // => true /* Async */ readFileList( [ __filename ], onFiles ); readFileList( [ 'beepboop' ], onFiles ); function onFiles( error, files ) { if ( error ) { if ( error.code === 'ENOENT' ) { console.error( 'A file does not exist.' ); } else { throw error; } } else { console.dir( files ); } } ```

## CLI

## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/fs-read-file-list-cli ```

### Usage ```text Usage: read-file-list [options] ... Options: -h, --help Print this message. -V, --version Print the package version. --enc, --encoding encoding Encoding. --flag flag Flag. Default: 'r'. ```

### Notes - Relative file paths are resolved relative to the current working directory. - Errors are written to `stderr`. - File contents are written to `stdout` as newline-delimited JSON ([NDJSON][ndjson]).

### Examples ```bash $ read-file-list ./README.md ./package.json {"file":"...","data":"..."} {"file":"...","data":"..."} ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 29

Last Year

Push event: 29

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 49
Total Committers: 1
Avg Commits per committer: 49.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 15
Committers: 1
Avg Commits per committer: 15.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	49

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- npm 31 last-month

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 0
(may contain duplicates)
Total versions: 14
Total maintainers: 4

npmjs.org: @stdlib/fs-read-file-list

Read the entire contents of each file in a file list.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 11
Dependent Packages: 2
Dependent Repositories: 0
Downloads: 25 Last month

Rankings

Dependent packages count: 9.5%

Downloads: 13.2%

Average: 16.4%

Stargazers count: 16.8%

Forks count: 17.4%

Dependent repos count: 25.3%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

npmjs.org: @stdlib/fs-read-file-list-cli

Read the entire contents of each file in a file list.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 6 Last month

Rankings

Dependent repos count: 33.9%

Average: 41.2%

Dependent packages count: 48.4%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

Dependencies

package.json npm

@stdlib/assert-is-browser ^0.0.x development
@stdlib/assert-is-json ^0.0.x development
@stdlib/assert-is-windows ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/process-exec-path ^0.0.x development
@stdlib/utils-index-of ^0.0.x development
@stdlib/utils-noop ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-function ^0.0.x
@stdlib/assert-is-string-array ^0.0.x
@stdlib/cli-ctor ^0.0.x
@stdlib/fs-read-file ^0.0.x
@stdlib/math-base-special-pow ^0.0.x
@stdlib/process-cwd ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/utils-copy ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x
@stdlib/utils-keys ^0.0.x
debug ^2.6.9

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite