{"id":17472537,"url":"https://github.com/shinnn/home-files","last_synced_at":"2025-10-29T00:36:54.393Z","repository":{"id":57264913,"uuid":"91693236","full_name":"shinnn/home-files","owner":"shinnn","description":"List all files in the home directory","archived":false,"fork":false,"pushed_at":"2018-02-07T06:37:56.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-01T00:55:03.358Z","etag":null,"topics":["async","enumeration","home","javascript","list","nodejs","promise"],"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-05-18T12:56:14.000Z","updated_at":"2018-02-14T04:09:42.000Z","dependencies_parsed_at":"2022-08-25T03:40:32.145Z","dependency_job_id":null,"html_url":"https://github.com/shinnn/home-files","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/shinnn/home-files","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fhome-files","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fhome-files/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fhome-files/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fhome-files/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinnn","download_url":"https://codeload.github.com/shinnn/home-files/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinnn%2Fhome-files/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259935602,"owners_count":22934386,"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","enumeration","home","javascript","list","nodejs","promise"],"created_at":"2024-10-18T17:26:15.068Z","updated_at":"2025-10-29T00:36:54.340Z","avatar_url":"https://github.com/shinnn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# home-files\n\n[![npm version](https://img.shields.io/npm/v/home-files.svg)](https://www.npmjs.com/package/home-files)\n[![Build Status](https://travis-ci.org/shinnn/home-files.svg?branch=master)](https://travis-ci.org/shinnn/home-files)\n[![Coverage Status](https://img.shields.io/coveralls/shinnn/home-files.svg)](https://coveralls.io/github/shinnn/home-files?branch=master)\n\nList all files in the [home directory](https://nodejs.org/api/os.html#os_os_homedir)\n\n```javascript\nconst homeFiles = require('home-files');\n\n(async () =\u003e await homeFiles() /* =\u003e Set {\n  '/Users/shinnn/.DS_Store',\n  '/Users/shinnn/.bash_history',\n  '/Users/shinnn/.bash_profile',\n  '/Users/shinnn/.bashrc',\n  '/Users/shinnn/.gitconfig',\n  ...\n  '/Users/shinnn/.zshrc'\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 home-files\n```\n\n## API\n\n```javascript\nconst homeFiles = require('home-files');\n```\n\n### homeFiles([*options*])\n\n*options*: `Object` (used as [`readdir-sorted` options](https://github.com/shinnn/readdir-sorted#readdirsortedpath--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 *files* included in the home directory. Symbolic links and directories are excluded.\n\nOptions are directly passed to the underlying [`readdir-sorted`](https://github.com/shinnn/readdir-sorted) to control the order of results.\n\n## License\n\n[ISC License](./LICENSE) © 2017 - 2018 Shinnosuke Watanabe\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fhome-files","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinnn%2Fhome-files","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinnn%2Fhome-files/lists"}