Package Exports
- @sapphire/node-utilities
Readme
@sapphire/node-utilities
Common NodeJS utilities for the Sapphire Community.
Table of Contents
Features
- Written in TypeScript
- Offers CommonJS, and ESM bundles
- Fully tested
Installation
You can use the following command to install this package, or replace npm install with your package manager of choice.
npm install @sapphire/node-utilitiesUsage
findFilesRecursively
Recursively searches for files in a directory and returns an AsyncIterableIterator of the found paths.
import { findFilesRecursively } from '@sapphire/node-utilities';
const files = findFilesRecursively('./src');
for await (const file of files) {
console.log(file);
}
// This, for example, could log:
// /root/src/index.js
// /root/src/database.csv
// /root/src/lib/utils/constants.json
// Alternate forms:
const files = findFilesRecursivelyStringStartsWith('./src', 'index'); // filename starts with "index"
const files = findFilesRecursivelyStringEndsWith('./src', '.js'); // filename ends with ".js"
const files = findFilesRecursivelyStringIncludes('./src', 'database'); // filename includes "database"
const files = findFilesRecursivelyRegex('./src', /\.[tj]sx?$/); // filename matches the regexBuy us some doughnuts
Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
| Donate With | Address |
|---|---|
| Open Collective | Click Here |
| Ko-fi | Click Here |
| Patreon | Click Here |
| PayPal | Click Here |
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!