{"id":19238554,"url":"https://github.com/tmpfs/fs-find","last_synced_at":"2025-06-25T06:37:09.104Z","repository":{"id":57242241,"uuid":"39176076","full_name":"tmpfs/fs-find","owner":"tmpfs","description":"Filesystem recursive asynchronous find","archived":false,"fork":false,"pushed_at":"2016-01-18T11:42:14.000Z","size":32,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-05T10:16:11.873Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmpfs.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":"2015-07-16T04:14:50.000Z","updated_at":"2019-04-02T00:18:04.000Z","dependencies_parsed_at":"2022-09-07T22:00:50.472Z","dependency_job_id":null,"html_url":"https://github.com/tmpfs/fs-find","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Ffs-find","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Ffs-find/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Ffs-find/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmpfs%2Ffs-find/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmpfs","download_url":"https://codeload.github.com/tmpfs/fs-find/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240324059,"owners_count":19783453,"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":[],"created_at":"2024-11-09T16:33:27.720Z","updated_at":"2025-02-23T13:52:53.888Z","avatar_url":"https://github.com/tmpfs.png","language":"JavaScript","readme":"Table of Contents\n=================\n\n* [Filesystem Find](#filesystem-find)\n  * [Install](#install)\n  * [Usage](#usage)\n    * [Arguments](#arguments)\n    * [Options](#options)\n    * [Filter](#filter)\n    * [Info](#info)\n  * [Developer](#developer)\n    * [Test](#test)\n    * [Cover](#cover)\n    * [Lint](#lint)\n    * [Docs](#docs)\n    * [Readme](#readme)\n  * [License](#license)\n\nFilesystem Find\n===============\n\n[\u003cimg src=\"https://travis-ci.org/tmpfs/fs-find.svg\" alt=\"Build Status\"\u003e](https://travis-ci.org/tmpfs/fs-find)\n[\u003cimg src=\"http://img.shields.io/npm/v/fs-find.svg\" alt=\"npm version\"\u003e](https://npmjs.org/package/fs-find)\n[\u003cimg src=\"https://coveralls.io/repos/tmpfs/fs-find/badge.svg?branch=master\u0026service=github\u0026v=1\" alt=\"Coverage Status\"\u003e](https://coveralls.io/github/tmpfs/fs-find?branch=master).\n\nZero-dependency, asynchronous filesystem walk.\n\nRequires [node](http://nodejs.org) and [npm](http://www.npmjs.org).\n\n## Install\n\n```\nnpm i fs-find --save\n```\n\n## Usage\n\n```javascript\nfind(path, [opts], cb)\n```\n\n```javascript\nvar find = require('fs-find')\n  , path = process.cwd();\nfind(path, function(err, results) {\n  if(err) {\n    return console.error(err);\n  }\n  console.dir(results);\n}\n```\n\n### Arguments\n\n* `path`: String or array of strings referencing directories and/or files.\n* `opts`: Processing options, see below.\n* `cb`: Callback function with signature `function(err, results)` where results \n  is an array of `info` objects.\n\n### Options\n\n* `dirs`: Include directories in results array (default: `false`).\n* `exclude`: Do not include the `path` argument values in the `results`.\n* `filter`: Generic filter function before `stat` is called.\n* `file`: Filter function for files.\n* `folder`: Filter function for directories.\n* `fullpath`: Use full file path for matching.\n* `followLinks`: Follow symbolic links (`stat` rather than `lstat`).\n* `depth`: Maximum folder depth to recurse.\n* `absolute`: Make all file paths absolute.\n* `dedupe`: Remove duplicate entries, possible if the `path` array contains \n  overlapping folders, best used with `absolute` enabled.\n\n### Filter\n\nFilter functions have the signature `function filter(path, info)` and should \nreturn a `boolean`. The `info` object may be modified in place and will be \nincluded in the results array.\n\n### Info\n\nThe `info` object contains the fields:\n\n* `file`: The full file path.\n* `name`: The basename of the file.\n* `folder`: The parent folder.\n* `matcher`: Either the file path or name depending upon the `fullpath` option.\n* `stat`: An `fs.Stats` object when available.\n* `base`: Base directory for the file.\n* `relative`: Path relative to `base`.\n\n## Developer\n\n### Test\n\nTo run the test suite:\n\n```\nnpm test\n```\n\n### Cover\n\nTo generate code coverage:\n\n```\nnpm run cover\n```\n\n### Lint\n\nRun the source tree through [jshint](http://jshint.com) and [jscs](http://jscs.info):\n\n```\nnpm run lint\n```\n\n### Docs\n\nTo build all documentation:\n\n```\nnpm run docs\n```\n\n### Readme\n\nTo build the readme file from the partial definitions (requires [mdp](https://github.com/tmpfs/mdp)):\n\n```\nnpm run readme\n```\n\n## License\n\nEverything is [MIT](http://en.wikipedia.org/wiki/MIT_License). Read the [license](https://github.com/tmpfs/fs-find/blob/master/LICENSE) if you feel inclined.\n\nGenerated by [mdp(1)](https://github.com/tmpfs/mdp).\n\n[node]: http://nodejs.org\n[npm]: http://www.npmjs.org\n[mdp]: https://github.com/tmpfs/mdp\n[jshint]: http://jshint.com\n[jscs]: http://jscs.info\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmpfs%2Ffs-find","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmpfs%2Ffs-find","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmpfs%2Ffs-find/lists"}