{"_id":"node-os-walk","_rev":"3-d71b1a3370df1663231964ef86432195","name":"node-os-walk","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"node-os-walk","version":"1.0.0","main":"./dist/index.js","license":"MIT","description":"Python's os.walk() implementation for Node.js environments with support for the `for await...of` loops.","author":{"name":"ncpa0cpl","email":"szymonb21@gmail.com","url":"https://github.com/ncpa0cpl"},"repository":{"url":"git+https://github.com/ncpa0cpl/node-os-walk.git"},"keywords":["python","os.walk","os","walk","async","fs","filesystem"],"scripts":{"build":"rm -rf ./dist && tsc -p tsconfig.build.json","lint":"eslint .","tsc":"tsc --noEmit","test":"jest --coverage"},"devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.7","@typescript-eslint/eslint-plugin":"^5.9.0","@typescript-eslint/parser":"^5.9.0","eslint":"^8.6.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","husky":"^7.0.4","jest":"^27.4.5","prettier":"^2.5.1","prettier-plugin-jsdoc":"^0.3.30","ts-jest":"^27.1.2","typescript":"^4.5.4"},"types":"./dist/index.d.ts","gitHead":"3c08f732516cd8554857fd30494f609e7c4b4e13","bugs":{"url":"https://github.com/ncpa0cpl/node-os-walk/issues"},"homepage":"https://github.com/ncpa0cpl/node-os-walk#readme","_id":"node-os-walk@1.0.0","_nodeVersion":"14.18.1","_npmVersion":"8.1.4","dist":{"integrity":"sha512-fnviFGVjwLVw3+4QK/iZwVXskwdsg8Bauw2NDyeHTn/g7FJh0XecBoVCZtDbuFB5ZYBs43UiX55MujFneu1giQ==","shasum":"fd9d3ef214f615060fa1b0439361359321e804a1","tarball":"https://registry.npmjs.org/node-os-walk/-/node-os-walk-1.0.0.tgz","fileCount":12,"unpackedSize":7446,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh1CtMCRA9TVsSAnZWagAAofQP/2aSMxtdjlJJTOOPxBuR\nGZ2GVFTQylOtMQ2rRb4UACgMZajZiaU24n6p5Y0d/anmGBiYA/ODa4IJ5aWA\nyEEOs9pCiFP1lgGOzS5NdMT0WIh5kYyVWBf6qLJFtx6nfdcuO0q5btDAjhwI\nvmgsSVDfcbmTsoO41W92MysY5OgB6HLKx7oGLKMNHZC0K9g2QrURWYqzNurd\nkUSgF8RKR68xB7f35wSAYd5oWw5SxKzoDlz3wmbjLHw8ogK/SQIj1hSTfP1S\n+lwqhtez30zFgSQ38Ry8J1hR4A/i36caF7cPdQW7sQE4l4tc82hNmjc4Lkfa\n3IyyUWYhdtAukg/vQlsryxJL1osaa6z8GrulkzH+vvASYHWuigeHntgrb3Bc\nszDxNiLFAdnR84N+dk1AlMr7N9kZlaTuWI5vf5P+y7ODvxchojC57JVQWzj/\nfuG3+KEFieuE2E21ZbD/BTdrrg0r/ABNa14EcqOchlEY6S22nay+PgDrA5k/\nDAvrEBBfghI2VzhgebUGQXZ+S3BDrjOZaRirH2u3iiq5S7BknU+dvfr6Yenw\n5wEs/h2RCmkqehc29yujNE5h2ScpYHq5zD8d/3ETeascDJ+/Dx0j8DhofiIv\nHYzGotUXWYlAEdxNHJPbK9qmVIZ3LDBrNYVzv99PD+O6uv30m86Dtwf7Kv4g\ncHYV\r\n=/UvH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCBKM7q6oUa6dXF7uwrGyhk5wC8WCwJOAbr3bfK3NUaMAIgU7ekctXDrshVAj6craqhU5foAqUhZpqWS2IVXZ+c9hA="}]},"_npmUser":{"name":"ncpa0cpl","email":"szymonb21@gmail.com"},"directories":{},"maintainers":[{"name":"ncpa0cpl","email":"szymonb21@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/node-os-walk_1.0.0_1641294668094_0.589529463717088"},"_hasShrinkwrap":false},"1.0.1":{"name":"node-os-walk","version":"1.0.1","main":"./dist/legacy/index.js","types":"./dist/types/index.d.ts","exports":{".":{"types":"./dist/types/index.d.ts","import":"./dist/esm/index.mjs","require":"./dist/cjs/index.cjs"}},"license":"MIT","description":"Python's os.walk() implementation for Node.js environments with support for the `for await...of` loops.","author":{"name":"ncpa0cpl","email":"szymonb21@gmail.com","url":"https://github.com/ncpa0cpl"},"repository":{"url":"git+https://github.com/ncpa0cpl/node-os-walk.git"},"keywords":["python","os.walk","os","walk","async","fs","filesystem"],"scripts":{"build":"rm -rf ./dist && node ./scripts/build.mjs","lint":"eslint .","tsc":"tsc --noEmit","test":"jest --coverage"},"devDependencies":{"@ncpa0cpl/nodepack":"^1.1.0","@types/jest":"^27.4.0","@types/node":"^17.0.7","@typescript-eslint/eslint-plugin":"^5.9.0","@typescript-eslint/parser":"^5.9.0","eslint":"^8.6.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","husky":"^7.0.4","jest":"^27.4.5","prettier":"^2.5.1","prettier-plugin-jsdoc":"^0.3.30","ts-jest":"^27.1.2","typescript":"^4.5.4"},"gitHead":"03a693d9f5f8237b3041653f5e7e88b298f9ee51","bugs":{"url":"https://github.com/ncpa0cpl/node-os-walk/issues"},"homepage":"https://github.com/ncpa0cpl/node-os-walk#readme","_id":"node-os-walk@1.0.1","_nodeVersion":"16.16.0","_npmVersion":"8.18.0","dist":{"integrity":"sha512-qevYsiS6swb9m+7KiEYJhs858+mNITA8FLHkcTfXkaDsewm45zQvkFkEwSzt59WTEjTksDcKzAXQ1Gg2S7hRAA==","shasum":"0701faf3a19a8bb48f222723098bfdcadbd0c40c","tarball":"https://registry.npmjs.org/node-os-walk/-/node-os-walk-1.0.1.tgz","fileCount":20,"unpackedSize":18248,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDYMoRcuOk+KlAqhWSc2QlJLspvZKeBa6ZleENFCaVBMgIhAIpPMJNBY4pWu/NWWYfulRLVIWQIEyYMSiZkhuhk7AC0"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjB4LgACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqBGw//e3JVmDxEa11y21ColPZocIbNIVaCp/wTNe1yPHLL3ljPJ189\r\nA1+n3rmmUGqHs8fM08mATiT6G53Yy9fKoR+7c8m/7IyjBjyPl3jFpMMD2C/8\r\neIFeuiia7qDrwUVimbx/IboT4VpH8Uepye+t3oJQHRGzaGMtjhQ/v+NRZQZo\r\ni31YF/Xy4u5LE4yR+ksFvdEGK2Dzhiosi7IKzEZilBUrr8BghaYUBdmD1gTg\r\nK1pzl2hOqRtqlqTRjpQCVW4F/bh3KUUHRcplvw6ODOMwqU7b2O/HfrH2EXCc\r\nKEWhM/EDRrPyG2hVZotxmB3TEtYwYmIWq/DyYEA7EgAUuOAL+ZXLOY9IJmre\r\na1aVPtPSTPaqcrC/km6ybccoDQc12T5TkRXdTs8tgiTAD4BiZVbBz0BLKZdG\r\n4DQTlTy59CDSgLIseCsHOQmszk9BGZU3KSjLt6moOwush/1bix/gMPG7fTDP\r\nV6Vl92EaT20KtdCGLaPUC87QGelylQ9YKiH1V0p02AvnAU8bhhtcFDW7fy5f\r\n0b/IEDt0c9RGnhFMvwKij2WA/VMm0aNnC5ESqjJpmh9z1mI7TvPrCEY70DwE\r\ncIvNRwg2fk1TPzPSQX6l9sOr2AKM+9wVWjCw1KDnHxEhtPhcAhXZbyAB4Pgz\r\nKfH/bTfO+OJmF/kWxGwkwkho/lg1CuWyBoE=\r\n=91sp\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ncpa0cpl","email":"szymonb21@gmail.com"},"directories":{},"maintainers":[{"name":"ncpa0cpl","email":"szymonb21@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/node-os-walk_1.0.1_1661436640677_0.08807308658850999"},"_hasShrinkwrap":false},"1.0.2":{"name":"node-os-walk","version":"1.0.2","main":"./dist/legacy/index.js","types":"./dist/types/index.d.ts","exports":{".":{"types":"./dist/types/index.d.ts","import":"./dist/esm/index.mjs","require":"./dist/cjs/index.cjs"}},"license":"MIT","description":"Python's os.walk() implementation for Node.js environments with support for the `for await...of` loops.","author":{"name":"ncpa0cpl","email":"szymonb21@gmail.com","url":"https://github.com/ncpa0cpl"},"repository":{"url":"git+https://github.com/ncpa0cpl/node-os-walk.git"},"keywords":["python","os.walk","os","walk","async","fs","filesystem"],"scripts":{"build":"rm -rf ./dist && node ./scripts/build.mjs","lint":"eslint .","tsc":"tsc --noEmit","test":"jest --coverage"},"devDependencies":{"@ncpa0cpl/nodepack":"^1.1.0","@types/jest":"^27.4.0","@types/node":"^17.0.7","@typescript-eslint/eslint-plugin":"^5.9.0","@typescript-eslint/parser":"^5.9.0","eslint":"^8.6.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","husky":"^7.0.4","jest":"^27.4.5","prettier":"^2.5.1","prettier-plugin-jsdoc":"^0.3.30","ts-jest":"^27.1.2","typescript":"^4.5.4"},"gitHead":"062155b0a8dce664074d6aa8dcc99fbe0b894f08","bugs":{"url":"https://github.com/ncpa0cpl/node-os-walk/issues"},"homepage":"https://github.com/ncpa0cpl/node-os-walk#readme","_id":"node-os-walk@1.0.2","_nodeVersion":"14.20.0","_npmVersion":"6.14.17","dist":{"integrity":"sha512-aJOH1sKNP2vdYZwLyaSqPouM5Bg5YnNd0t/8cdLz2mjxDGxZyqFpa7vTsbhfjUdJM3ZBwiLPwu84kl2tET8T+Q==","shasum":"82011408577437856451398f14cfe7fd0982902f","tarball":"https://registry.npmjs.org/node-os-walk/-/node-os-walk-1.0.2.tgz","fileCount":20,"unpackedSize":17906,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEsMUJIpWTJlt+dXzBkMS6IXghKkrm6TirtATdvT+USDAiEAxpZTgjIw6XuXzv3KpixyJCcZUU6/BHymIpcR0u315AU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjEIpSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrbPxAAg0cSnPcpjPZG5QOxvo+y+x7McWaRwgMPFX5d3hCcRSSICwlQ\r\niJQRYAzx8EPYDoSz0LYvRAXeyMsoeq+tJe36DN9HiURLqMcEfMA1rkYanp4Q\r\nsWZ9TYE2g9NOjONmma76HWRsxpXVHOoas2pFm0gfgSNaxm4XtDmWQDnMC6T5\r\n/wbfdwv7KLGF3mPPJsLGXGuSGvD1pwPAQMNpVSRL+SL5eLIDlMXagom2aAmd\r\nvYOGWwDUy09KyP9kZhfBotHKx4iUMudHl69nGryQ5xxNHbD8hM75qzhKJg2e\r\n/EQfA12QDCjhfmNF4Yun/aVrOM6TzY9yT8pCOCjEt7T/ayyKpqLtgHg+cqJn\r\nGo9mRi1AMx7jT7c3eWudKWwtPYVsSJWTJVnoWwgl2bzCLJe9wi8DNaXBMOJW\r\nT6LuK/tHitMAU3YyvcIb6Hb2imbRzqc77/qaaIpASfyBMxfzN4Sb2vDrZMwt\r\nErkTE5Vfsf02CwFKVjZzMWglzM2BYyDNDNXmfEAEApnvJ8Zd7kshxPnDnQfE\r\n/QQt5rsgbHPzw8zl67CDsytTa0UotG5cVXcrfJ/oElhFLD2ZIaBQHUa/gqc9\r\n5Jb5/1h8w1XCbpguMwa3J5LKJX/GfdPurUjdJVbRwN9ZYnEF3rqKM/U7oc75\r\nfs3gYWGskjX1tHV8jGlhdEy4r6qTDrLRFLk=\r\n=QKyM\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ncpa0cpl","email":"szymonb21@gmail.com"},"directories":{},"maintainers":[{"name":"ncpa0cpl","email":"szymonb21@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/node-os-walk_1.0.2_1662028370295_0.8366723842066397"},"_hasShrinkwrap":false}},"time":{"created":"2022-01-04T11:11:08.094Z","1.0.0":"2022-01-04T11:11:08.272Z","modified":"2022-09-01T10:32:50.509Z","1.0.1":"2022-08-25T14:10:40.893Z","1.0.2":"2022-09-01T10:32:50.439Z"},"maintainers":[{"name":"ncpa0cpl","email":"szymonb21@gmail.com"}],"description":"Python's os.walk() implementation for Node.js environments with support for the `for await...of` loops.","homepage":"https://github.com/ncpa0cpl/node-os-walk#readme","keywords":["python","os.walk","os","walk","async","fs","filesystem"],"repository":{"url":"git+https://github.com/ncpa0cpl/node-os-walk.git"},"author":{"name":"ncpa0cpl","email":"szymonb21@gmail.com","url":"https://github.com/ncpa0cpl"},"bugs":{"url":"https://github.com/ncpa0cpl/node-os-walk/issues"},"license":"MIT","readme":"# node-os-walk\n\nPython's os.walk() implementation for Node.js environments with support for the `for await...of` loops.\n\n> It is recommended to use ECMA 2018 target or newer with the `node-os-walk` lib.\n> `for await...of` loops are not supported in older versions.\n\n## Description\n\nGenerate the file names in a directory tree by walking the tree top-down. For each directory in the tree rooted at directory top (including top itself), it yields a 3-tuple: `[dirpath: string, directories: Array, files: Array]`\n\n- `dirpath` - is a string, the path to the directory.\n- `directories` - is a list of `Dirent` objects (from the standard fs Node library) pointing to all of directories found in the `dirpath`\n- `files` - is a list of `Dirent` objects (from the standard fs Node library) pointing to all of files but not directories found in the `dirpath`\n\n### Example\n\n```ts\nimport { walk } from \"node-os-walk\";\nimport path from \"path\";\n\nasync function main() {\n const rootPath = path.resolve(__dirname, \"./\");\n\n for await (const [root, dirs, files] of walk(rootPath)) {\n for (const directory of dirs) {\n console.log(\"Directory:\", path.resolve(root, directory.name));\n }\n\n for (const file of files) {\n console.log(\"File:\", path.resolve(root, file.name));\n }\n }\n}\n```\n\n## Options\n\n- **followSymlinks** - by default `walk()` will not list the contents of directories pointed to with symlinks, set this to true to change this behavior.\n\n > `walk(rootPath, { followSymlinks: true })`\n\n- **ignoreErrors** - walk uses the `fs.readdir()` internally, if this option is set to true any errors thrown by `fs.readdir()` will be suppressed and an empty list of dirs and files will be returned.\n > `walk(rootPath, { ignoreErrors: true })`\n","readmeFilename":"README.md"}