{"id":18179316,"url":"https://github.com/stdlib-js/fs-read-dir","last_synced_at":"2026-03-16T03:34:20.108Z","repository":{"id":57162669,"uuid":"376622398","full_name":"stdlib-js/fs-read-dir","owner":"stdlib-js","description":"Read the entire contents of a directory.","archived":false,"fork":false,"pushed_at":"2025-03-10T01:51:43.000Z","size":472,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-15T18:54:32.736Z","etag":null,"topics":["async","dir","directory","filesystem","fs","javascript","node","node-js","nodejs","open","path","read","readdir","readdirsync","stdlib","sync"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-13T19:15:58.000Z","updated_at":"2025-03-10T01:12:45.000Z","dependencies_parsed_at":"2023-02-17T06:05:26.016Z","dependency_job_id":"2b001bcc-72ac-4698-bdb9-0fdbab43d90f","html_url":"https://github.com/stdlib-js/fs-read-dir","commit_stats":{"total_commits":64,"total_committers":1,"mean_commits":64.0,"dds":0.0,"last_synced_commit":"30300e8c760992760e865c42ea8c6830f2bd2185"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-read-dir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-read-dir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-read-dir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-read-dir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/fs-read-dir/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246644096,"owners_count":20810687,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","dir","directory","filesystem","fs","javascript","node","node-js","nodejs","open","path","read","readdir","readdirsync","stdlib","sync"],"created_at":"2024-11-02T18:08:55.643Z","updated_at":"2026-03-16T03:34:20.101Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Read Directory\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Read the contents of a directory.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/fs-read-dir\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar readDir = require( '@stdlib/fs-read-dir' );\n```\n\n#### readDir( path, clbk )\n\nAsynchronously reads the contents of a directory.\n\n```javascript\nreadDir( __dirname, onRead );\n\nfunction onRead( error, data ) {\n    if ( error ) {\n        console.error( error );\n    } else {\n        console.log( data );\n        // =\u003e [...]\n    }\n}\n```\n\n#### readDir.sync( path )\n\nSynchronously reads the contents of a directory.\n\n```javascript\nvar out = readDir.sync( __dirname );\nif ( out instanceof Error ) {\n    throw out;\n}\nconsole.log( out );\n// =\u003e [...]\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   The difference between this module and [`fs.readdirSync()`][fs] is that [`fs.readdirSync()`][fs] will throw if an `error` is encountered (e.g., if given a non-existent `path`) and this module will return an `error`. Hence, the following anti-pattern\n\n    ```javascript\n    var fs = require( 'fs' );\n\n    var dir = '/path/to/dir';\n\n    // Check for existence to prevent an error being thrown...\n    if ( fs.existsSync( dir ) ) {\n        dir = fs.readdirSync( dir );\n    }\n    ```\n\n    can be replaced by an approach which addresses existence via `error` handling.\n\n    ```javascript\n    var readDir = require( '@stdlib/fs-read-dir' );\n\n    var dir = '/path/to/dir';\n\n    // Explicitly handle the error...\n    dir = readDir.sync( dir );\n    if ( dir instanceof Error ) {\n        // You choose what to do...\n        throw dir;\n    }\n    ```\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar readDir = require( '@stdlib/fs-read-dir' );\n\n/* Sync */\n\nvar out = readDir.sync( __dirname );\n// returns \u003cArray\u003e\n\nconsole.log( out instanceof Error );\n// =\u003e false\n\nout = readDir.sync( 'beepboop' );\n// returns \u003cError\u003e\n\nconsole.log( out instanceof Error );\n// =\u003e true\n\n/* Async */\n\nreadDir( __dirname, onRead );\nreadDir( 'beepboop', onRead );\n\nfunction onRead( error, data ) {\n    if ( error ) {\n        if ( error.code === 'ENOENT' ) {\n            console.error( 'Directory does not exist.' );\n        } else {\n            throw error;\n        }\n    } else {\n        console.log( data );\n    }\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n* * *\n\n\u003csection class=\"cli\"\u003e\n\n## CLI\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\nTo use as a general utility, install the CLI package globally\n\n```bash\nnpm install -g @stdlib/fs-read-dir-cli\n```\n\n\u003c/section\u003e\n\n\u003c!-- CLI usage documentation. --\u003e\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```text\nUsage: read-dir [options] \u003cdirpath\u003e\n\nOptions:\n\n  -h,    --help                Print this message.\n  -V,    --version             Print the package version.\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n### Notes\n\n-   Relative paths are resolved relative to the current working directory.\n-   Errors are written to `stderr`.\n-   Directory contents are written to `stdout`.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```bash\n$ read-dir ./../\n...\n...\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.cli --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/fs-exists`][@stdlib/fs/exists]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003etest whether a path exists on the filesystem.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/fs-read-file`][@stdlib/fs/read-file]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eread the entire contents of a file.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2026. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/fs-read-dir.svg\n[npm-url]: https://npmjs.org/package/@stdlib/fs-read-dir\n\n[test-image]: https://github.com/stdlib-js/fs-read-dir/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/fs-read-dir/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-read-dir/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/fs-read-dir?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/fs-read-dir.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/fs-read-dir/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg\n[chat-url]: https://stdlib.zulipchat.com\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[cli-section]: https://github.com/stdlib-js/fs-read-dir#cli\n[cli-url]: https://github.com/stdlib-js/fs-read-dir/tree/cli\n[@stdlib/fs-read-dir]: https://github.com/stdlib-js/fs-read-dir/tree/main\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/fs-read-dir/tree/deno\n[deno-readme]: https://github.com/stdlib-js/fs-read-dir/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/fs-read-dir/tree/umd\n[umd-readme]: https://github.com/stdlib-js/fs-read-dir/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/fs-read-dir/tree/esm\n[esm-readme]: https://github.com/stdlib-js/fs-read-dir/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/fs-read-dir/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-read-dir/main/LICENSE\n\n[fs]: https://nodejs.org/api/fs.html\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/fs/exists]: https://github.com/stdlib-js/fs-exists\n\n[@stdlib/fs/read-file]: https://github.com/stdlib-js/fs-read-file\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Ffs-read-dir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Ffs-read-dir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Ffs-read-dir/lists"}