{"_id":"read-dir-safe","_rev":"2-3ffb4eef273634c8ae88e50bf987dc93","name":"read-dir-safe","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"read-dir-safe","version":"1.0.0","description":"Read directories recursively or non-recursively","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-dir-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-dir-safe.git"},"keywords":[],"main":"./build/index.js","scripts":{"build":"bob build","commit":"bob commit","lint":"bob lint","release":"bob publish","test":"bob test"},"devDependencies":{"@bconnorwhite/bob":"^2.9.2","@types/mock-fs":"^4.10.0","@types/node":"^14.11.2","mock-fs":"^4.13.0"},"eslintConfig":{"extends":"eslint-config-bob"},"husky":{"hooks":{"commit-msg":"bob lint commit"}},"npmpackagejsonlint":{"extends":"npm-package-json-lint-config-bob"},"_id":"read-dir-safe@1.0.0","dist":{"shasum":"7678512216f0b9f86d0196e9188f99660cae773f","integrity":"sha512-0nIl8EGs6rwPnhsHO/82RdjiwyLcjb4okGLXc0cHlFE74VxCe0vmJow2M/bNi/yGAC8/7Nge/PzNTCC74MFbfQ==","tarball":"https://registry.npmjs.org/read-dir-safe/-/read-dir-safe-1.0.0.tgz","fileCount":7,"unpackedSize":8153,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfeAv3CRA9TVsSAnZWagAA3h0P/itjXRTnUdRqDSeWDHM/\n0s2DsA+EeqzDMMU9+tQ24JHT1VMp30dzAL3teLXSUQ+u5cNl58h2iMOr/CEp\nEbGAigySRc+qVsFHAWWwDyEYciJ6Z2FrQPCQ2DEz6cX0wkgJHXy6ROqM+JSU\npuaRNcsjkWcWY1jaEBADrHoiJIVRJxtHBivWP5jh6QW2WxIzslO1qwh5SmPq\np4FYWmVanM+IVu9lTO+F7VcEl4U4T0ucgU7QZZIyrznmLeyE9akRCd36aQzw\nVgKjvGA3W8OJ3to2wQU9XUoFOy0g68mC4gU3TwlYP37ejF8+Wrq9DnT01q8C\noBzcy5t0uxrEPTiMXrLDmnzZnazvxlFfr7Bedke7mwIm/45Gd50DytUOpu0k\n8RlG55yq7FJesZ5lDdKtfiF05E14kAFIcICsSzaSFvk6DLmPR6tuaJxqj+Qf\nTzMMi01xVGYZn++zr68aME3j1eHRBk6vklZV5gkmr7JY1MD9zNnYiqntr6vO\n0WRN3ohj2v0z6sZkr+ip7Np/k7uhFVueae/+GIL6hHqKEkt+v+dcPvBkjAt2\n0LNeqd8u2Zmp4e7UhxLtfOtJ0OXEfelVJT4Vkdtrtgcyd1Dla20OvUPhlQRE\nGb3ohHNtyXe5a11Puga9DENRnu5YuGMIudNZX6XuPOFCR8TP+Bmg/Kd/msE+\nYpXr\r\n=ss2D\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDPigAVH2ZaLMNsZrEmDUC4xSS2Q7ZuAXEj+Z+eN9XeZAIgS2gML0U59veDzSmAoA2d55OjiY+ol7ellc5jMSq69ZU="}]},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-dir-safe_1.0.0_1601702903206_0.39178331685841816"},"_hasShrinkwrap":false},"1.0.1":{"name":"read-dir-safe","version":"1.0.1","description":"Read directories recursively or non-recursively","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-dir-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-dir-safe.git"},"keywords":[],"main":"./build/index.js","scripts":{"build":"bob build","commit":"bob commit","lint":"bob lint","release":"bob publish","test":"bob test"},"devDependencies":{"@bconnorwhite/bob":"^2.9.2","@types/mock-fs":"^4.10.0","@types/node":"^14.11.2","mock-fs":"^4.13.0"},"eslintConfig":{"extends":"eslint-config-bob"},"husky":{"hooks":{"commit-msg":"bob lint commit"}},"npmpackagejsonlint":{"extends":"npm-package-json-lint-config-bob"},"_id":"read-dir-safe@1.0.1","dist":{"shasum":"8dfd681490c37dc4c7b0eb169db4a5000ce2ed7e","integrity":"sha512-QpoRrEuX3Zaz1Ze7qDcajKFsnQ7Kx8pI2XnQ9Qaf73tTrmgcsM0lcvLcOCpPmlaSH9ASl3XjhJ41m529pSOr5g==","tarball":"https://registry.npmjs.org/read-dir-safe/-/read-dir-safe-1.0.1.tgz","fileCount":7,"unpackedSize":8445,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfegXOCRA9TVsSAnZWagAAM3AP/iDmXL1ZYY1+85wpye5r\n9WkCiTV46ucK/W2xLU75uZKqRNjQtpdRMpb0+ZlXZ2nW/L5ObUbhZFQv77x1\nb4jDkq8OrhlPLyhhglmiZZ6niiZxNwxhIy4WLd5Xc7V+t1H5oaN/HNzn1A2a\nl9UsezT8YkLfN1+/q3YpcuALLCgol0h/+9wBf4rbumJsd7CisbdOrvPBbOW8\nbQBDmyZMYx4egFdh2CrP1XuzS90uWaTFT2GaL+VO1kJdvdsPJ2nnN2LUzfpp\nSbN/lslskKF17BLwJ3kqAJzSfG5cuVWw/dOL3M9K8K3boL0l9vkurqkp3zPl\nrT6aGRi/kBBbB6Hxw3AzF2BIimxGIzcdgKXe4/PjxZ3RQvPt+L1u1R8YhE4g\nn+d2dODvvDmH+tU5K6NqQm0ciusxg/KdJWOMp8MTBjmjfRIrLs9XqeHMDHTq\nLdtAuSfRYbTE7jO44yh5VKuiD2X18bEKCZN2OyM/3yOeN+WsLkxQx02/WEoJ\n4H9wrr3exCa3SXJjvT/X5EgahSasYEsygqyBeNxsPbd5MxhmvIvUyvB1ysEY\no9L9tcsQCYorAiLQEqXswlnbCu9VWze1y2Vw+ijTuFIZXF/gsuSuGBJtKgeU\nTT3zbMLvbQkzPnmDFDQmx1pfY+JPCh+igR6SMhSw5Fsf1DU42h9rG+SAIJrD\nNq/C\r\n=9Kpa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDzeXQ15lJNSvwqdnIWXgH9FWgELUHfXogzJqKyQe3QhwIgUvX3PLCvWNZbXLmy3vLBs7uLSncxNTHVyE0Lrn4JaYU="}]},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-dir-safe_1.0.1_1601832397503_0.30131584579822346"},"_hasShrinkwrap":false}},"time":{"created":"2020-10-03T05:28:23.206Z","1.0.0":"2020-10-03T05:28:23.309Z","modified":"2022-05-15T12:02:25.247Z","1.0.1":"2020-10-04T17:26:37.656Z"},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"description":"Read directories recursively or non-recursively","homepage":"https://connorwhite.org/github/read-dir-safe","keywords":[],"repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-dir-safe.git"},"author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"license":"MIT","readme":"
\n \n \"read-dir-safe\"\n \n \n \"NPM\"\n \n \n \"TypeScript\"\n \n \n \"Coverage\n \n \n \"GitHub\n \n \n \"Twitter\n \n
\n\n
\n\n> Read directories recursively or non-recursively.\n\n- Returns an array of relative file paths.\n- Rather than throwing, returns `undefined` on errors for the root directory you are reading (for example, if you try to read a directory that does not exist).\n\n## Installation\n\n```sh\nyarn add read-dir-safe\n```\n\n```sh\nnpm install read-dir-safe\n```\n\n## API\n\n```ts\nimport { readDir, readDirSync, Options } from \"read-dir-safe\";\n\nfunction readDir(path: string, options: Options): Promise;\n\nfunction readDirSync(path: string, options: Options): string[] | undefined;\n\ntype Options = {\n /**\n * Recursively read child directories as well. Default: `true`\n */\n recursive?: boolean;\n /**\n * Whether to include directories in the results. Default: `false`\n */\n includeDirectories?: boolean;\n}\n```\n\n
\n\n

Dev Dependencies\"David\"

\n\n- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for typescript projects\n- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs\n- [@types/node](https://www.npmjs.com/package/@types/node): TypeScript definitions for Node.js\n- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system. You know, for testing.\n\n
\n\n

License \"license\"

\n\n[MIT](https://opensource.org/licenses/MIT)\n\n
\n\n## Related Packages\n\n- [fs-safe](https://www.npmjs.com/package/fs-safe): A simple fs wrapper that doesn't throw\n- [write-dir-safe](https://www.npmjs.com/package/read-dir-safe): Create directories and their parents recursively\n- [remove-dir-safe](https://www.npmjs.com/package/remove-dir-safe): Remove directories recursively or non-recursively\n- [read-file-safe](https://www.npmjs.com/package/read-file-safe): Read files without try catch\n- [write-file-safe](https://www.npmjs.com/package/write-file-safe): Write files, and parent directories if necessary\n- [remove-file-safe](https://www.npmjs.com/package/remove-file-safe): Remove a file without try catch\n","readmeFilename":"README.md"}