{"id":13827766,"url":"https://github.com/terkelg/powerwalker","last_synced_at":"2025-05-12T15:32:31.210Z","repository":{"id":57329152,"uuid":"134105109","full_name":"terkelg/powerwalker","owner":"terkelg","description":"🏃Walk directories recursively.","archived":false,"fork":false,"pushed_at":"2020-03-18T13:19:39.000Z","size":132,"stargazers_count":28,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-31T11:59:20.185Z","etag":null,"topics":["directory","filesystem","io","nodejs","walker"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terkelg.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/funding.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"terkelg"}},"created_at":"2018-05-19T23:27:23.000Z","updated_at":"2023-03-17T14:40:01.000Z","dependencies_parsed_at":"2022-09-01T15:31:27.998Z","dependency_job_id":null,"html_url":"https://github.com/terkelg/powerwalker","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terkelg%2Fpowerwalker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terkelg%2Fpowerwalker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terkelg%2Fpowerwalker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terkelg%2Fpowerwalker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terkelg","download_url":"https://codeload.github.com/terkelg/powerwalker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225141718,"owners_count":17427359,"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":["directory","filesystem","io","nodejs","walker"],"created_at":"2024-08-04T09:02:07.455Z","updated_at":"2024-11-18T06:54:40.789Z","avatar_url":"https://github.com/terkelg.png","language":"JavaScript","funding_links":["https://github.com/sponsors/terkelg"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/terkelg/powerwalker/raw/master/powerwalker.png\" alt=\"Power Walker\" width=\"240\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003ePower Walker\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://npmjs.org/package/powerwalker\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/powerwalker.svg\" alt=\"version\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/terkelg/powerwalker\"\u003e\n    \u003cimg src=\"https://img.shields.io/travis/terkelg/powerwalker.svg\" alt=\"travis\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://ci.appveyor.com/project/terkelg/powerwalker/branch/master\"\u003e\n    \u003cimg src=\"https://ci.appveyor.com/api/projects/status/svaorudqednb1tyi/branch/master?svg=true\" alt=\"AppVeyor\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://npmjs.org/package/powerwalker\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/powerwalker.svg\" alt=\"downloads\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003cb\u003eWalk directories recursively\u003c/b\u003e\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\n\u003e \"All truly great thoughts are conceived by walking\"\n\u003e – Friedrich Nietzsche\n\n\n## Installation\n\n```\nnpm install powerwalker\n```\n\n\n## Usage\n\n```js\nconst walk = require('powerwalker');\n\nlet files = await walk('path/to/walk');\n```\n\n## API\n\n\n### walk(dir, options)\n\nType: `Promise`\u003cbr\u003e\nReturns: `Array`\n\nList all files and directories in `dir` recursively.\n\n#### dir\n\nType: `String`\n\nA directory path to walk recursively.\n\n#### options\n\nType: `Object`\u003cbr\u003e\nDefault: `{ maxdepth: Infinity, flatten: true, filesonly: false }`\n\nOptional options object.\n\n#### options.maxdepth\n\nType: `Number`\u003cbr\u003e\nDefault: `Infinity`\n\nMax number of directories to walk before stopping.\n\n#### options.flatten\n\nType: `Boolean`\u003cbr\u003e\nDefault: `true`\n\nOption to flatten the output to a 1D array.\n\n#### options.filesonly\n\nType: `Boolean`\u003cbr\u003e\nDefault: `false`\n\nExclude directories from result.\n\n#### options.relative\n\nType: `Boolean`\u003cbr\u003e\nDefault: `true`\n\nReturn relative paths, or absolute paths.\n\n#### options.cwd\n\nType: `String`\u003cbr\u003e\nDefault: `'.'`\n\nCustom working directory. All paths are relative to this.\n\n\n## License\n\nMIT © [Terkel Gjervig](https://terkel.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterkelg%2Fpowerwalker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterkelg%2Fpowerwalker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterkelg%2Fpowerwalker/lists"}