0.0.4 • Published 7 months ago
@iohub/collect v0.0.4
@iohub/collect
Powerful filesystem collection utilities for Node.js
Features
- Efficient file and directory collection utilities
- Promise-based async/await API
- TypeScript support
- Zero dependencies for core functionality
Installation
# npm
npm install @iohub/collect
# yarn
yarn add @iohub/collect
# pnpm
pnpm add @iohub/collect
API
File Collection
import {
collectDocItems,
collectDocPaths,
collectDocs,
collectNames,
collectNameExts,
collectExts
} from '@iohub/collect'
// Get file entries (Dirent objects)
const files = await collectDocItems('./docs')
// Get full file paths
const paths = await collectDocPaths('./docs')
// Get filenames with extensions
const docs = await collectDocs('./docs')
// Get filenames without extensions
const names = await collectNames('./docs')
// Get filename-extension pairs
const nameExts = await collectNameExts('./docs')
// Get unique file extensions
const extensions = await collectExts('./docs')
Directory Collection
import { collectDirItems, collectDirs } from '@iohub/collect'
// Get directory entries (Dirent objects)
const dirEntries = await collectDirItems('./src')
// Get directory names
const directories = await collectDirs('./src')
License
Copyright (c) 2019-present, Hoyeung Wong
//: <> (Shields)
//: <> (Link)