{"id":17472797,"url":"https://github.com/shinnn/list-directories","last_synced_at":"2025-04-09T23:00:22.114Z","repository":{"id":57141798,"uuid":"99106546","full_name":"shinnn/list-directories","owner":"shinnn","description":"List all directories in a given directory","archived":false,"fork":false,"pushed_at":"2019-01-17T18:00:55.000Z","size":56,"stargazers_count":5,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-23T22:55:10.144Z","etag":null,"topics":["async-await","directory","filesystem","iterable","javascript","list","nodejs","promise","set"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shinnn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-02T10:58:04.000Z","updated_at":"2023-02-23T04:35:48.000Z","dependencies_parsed_at":"2022-09-05T18:50:48.222Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/list-directories","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Flist-directories","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Flist-directories/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Flist-directories/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Flist-directories/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/list-directories/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248125581,"owners_count":21051768,"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-await","directory","filesystem","iterable","javascript","list","nodejs","promise","set"],"created_at":"2024-10-18T17:36:54.505Z","updated_at":"2025-04-09T23:00:22.028Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# list-directories\n\n[![npm version](https://img.shields.io/npm/v/list-directories.svg)](https://www.npmjs.com/package/list-directories)\n[![Build Status](https://travis-ci.org/shinnn/list-directories.svg?branch=master)](https://travis-ci.org/shinnn/list-directories)\n[![Coverage Status](https://img.shields.io/coveralls/shinnn/list-directories.svg)](https://coveralls.io/github/shinnn/list-directories?branch=master)\n\nList all directories in a given directory\n\n```javascript\nconst listDirectories = require('list-directories');\n\n/*\n  ./my-dir/a: file\n  ./my-dir/b: directory\n  ./my-dir/c: symlink to a directory\n  ./my-dir/d: directory\n*/\n\n(async () =\u003e {\n  await listDirectories('my-dir');\n  /* =\u003e Set {\n    '/Users/example/my-dir/b',\n    '/Users/example/my-dir/d'\n  } */\n})();\n```\n\n## Installation\n\n[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).\n\n```\nnpm install list-directories\n```\n\n## API\n\n```javascript\nconst listDirectories = require('list-directories');\n```\n\n### listDirectories(*dir*)\n\n*dir*: `string` `Buffer` `URL` (directory path)  \n*options*: `Object` ([`readdir-sorted`](https://github.com/shinnn/readdir-sorted) options)  \nReturn: `Promise\u003cSet\u003cstring\u003e\u003e`\n\nThe promise will be fulfilled with a [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set) of strings — absolute paths of all directories included in the given directory.\n\nOptions are directly passed to the underlying [`readdir-sorted`](https://github.com/shinnn/readdir-sorted#readdirsortedpath--options) to control the order of results.\n\n```javascript\nlistDirectories('/dirs').then(files =\u003e {\n  const iterator = files[Symbol.iterator];\n\n  iterator.next().value; //=\u003e '/dirs/10'\n  iterator.next().value; //=\u003e '/dirs/2a'\n  iterator.next().value; //=\u003e '/dirs/2A'\n});\n\nlistDirectories('/dirs', {\n  numeric: true,\n  caseFirst: 'upper'\n}).then(files =\u003e {\n  const iterator = files[Symbol.iterator];\n\n  iterator.next().value; //=\u003e '/dirs/2A'\n  iterator.next().value; //=\u003e '/dirs/2a'\n  iterator.next().value; //=\u003e '/dirs/10'\n});\n```\n\n## License\n\n[ISC License](./LICENSE) © 2018 Shinnosuke Watanabe\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Flist-directories","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Flist-directories","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Flist-directories/lists"}