{"id":17816443,"url":"https://github.com/zebrajaeger/filewalker","last_synced_at":"2025-06-16T00:09:22.557Z","repository":{"id":57170473,"uuid":"291212231","full_name":"zebrajaeger/filewalker","owner":"zebrajaeger","description":null,"archived":false,"fork":false,"pushed_at":"2020-09-13T08:52:24.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-05T12:40:25.403Z","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":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zebrajaeger.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":"2020-08-29T06:08:31.000Z","updated_at":"2020-09-13T08:52:02.000Z","dependencies_parsed_at":"2022-08-27T12:02:05.279Z","dependency_job_id":null,"html_url":"https://github.com/zebrajaeger/filewalker","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/zebrajaeger/filewalker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zebrajaeger%2Ffilewalker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zebrajaeger%2Ffilewalker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zebrajaeger%2Ffilewalker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zebrajaeger%2Ffilewalker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zebrajaeger","download_url":"https://codeload.github.com/zebrajaeger/filewalker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zebrajaeger%2Ffilewalker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260072806,"owners_count":22954926,"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-10-27T16:38:09.278Z","updated_at":"2025-06-16T00:09:22.527Z","avatar_url":"https://github.com/zebrajaeger.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Filewalker\n\nSimple synchron filewalker for node and local filesystem.\n\n## Install\n\n```bash\nnpm install --save @zebrajaeger/filewalker\n```\n```bash\nyarn add @zebrajaeger/filewalker\n```\n\n## Examples\n\n### Basic\n\n```javascript\nconst {FileWalker} = require('@zebrajaeger/filewalker');\n\n// create instance\nconst fileWalker = new FileWalker('/media/l/Seagate');\n\n// start (returns Promise so we call '.then()')\nfileWalker.walk((f) =\u003e console.log('File', f), (d)=\u003e console.log('Directory', d)).then();\n```\n\nreturns i.E.\n```bash\n[...]\n\nDirectory { abs: '/media/l/Seagate/Seagate', rel: 'Seagate' }\nDirectory {\n  abs: '/media/l/Seagate/Seagate/Registration',\n  rel: 'Seagate/Registration'\n}\nFile {\n  abs: '/media/l/Seagate/Seagate/Registration/SerialNumber.xml',\n  rel: 'Seagate/Registration/SerialNumber.xml'\n}\n\n[...]\n```\n\n### Start deeper but get the relative path to root directory.\n```javascript\nconst {FileWalker} = require('@zebrajaeger/filewalker');\n\nconst fileWalker = new FileWalker('/media/l/Seagate');\nfileWalker.walk(\n    (f) =\u003e console.log('File', f),\n    (d)=\u003e console.log('Directory', d),\n    {relStart: 'Seagate'}).then();\n```\n\nreturns i.E.\n```bash\n\n```\n\n## Example with files and directories\n\n```javascript\nconst {FileWalker} = require('@zebrajaeger/filewalker');\n\nwalkSync(\n    '.', \n    (file) =\u003e console.log('File:', file),\n    (dir) =\u003e console.log('Directory:', dir)\n).then();\n```\n\n## Example files only\n\n```javascript\nconst {FileWalker} = require('@zebrajaeger/filewalker');\n\nwalkSync(\n    '.', \n    (file) =\u003e console.log('File:', file)\n).then();\n```\n\n## Example directories only\n\n```javascript\nconst {FileWalker} = require('@zebrajaeger/filewalker');\n\nwalkSync(\n    '.',\n    null, \n    (dir) =\u003e console.log('Directory:', dir)\n).then();\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzebrajaeger%2Ffilewalker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzebrajaeger%2Ffilewalker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzebrajaeger%2Ffilewalker/lists"}