0.4.0 ā¢ Published 3 years ago
@open-tech-world/node-glob v0.4.0
@open-tech-world/node-glob
Match files & directories using glob patterns.
It uses @open-tech-worl/es-glob for matching paths.
See the list of supported glob patterns here.
Features
āļø Sync Matching API
š§ Async Matching API
āļø Supports Multiple Patterns
Installation
Using npm
npm install @open-tech-world/node-globUsing Yarn
yarn add @open-tech-world/node-globUsage
import { globSync } from '@open-tech-world/node-glob';
globSync(patterns: string | string[],
options?: Partial<IOptions>): string[];Options
| Name | Type | Default | Description |
|---|---|---|---|
| cwd | string | process.cwd() | The current working directory in which to search files & folders. |
| dot | boolean | false | If true, it matches files & directories that begin with a "."(dot) character. |
| absolute | boolean | false | If true, it returns the absolute path. |
| dirs | boolean | true | If false, it does not include directories. |
| files | boolean | true | If false, it does not include files. |
Examples
my-app/
āā node_modules/
āā public/
ā āā favicon.ico
ā āā index.html
ā āā robots.txt
āā src/
ā āā index.css
ā āā index.js
āā .gitignore
āā package.json
āā README.mdimport { globSync } from '@open-tech-world/node-glob';
globSync(['*']) // ['node_modules', 'public', 'src', 'package.json', 'README.md']
globSync(['*'], { dot: true }) // ['node_modules', 'public', 'src', '.gitignore', 'package.json', 'README.md']
globSync(['*', '!node_modules']) // ['public', 'src', 'package.json', 'README.md']
globSync(['*.json']) // ['package.json']
globSync(['src/index.*']) // ['src/index.css', 'src/index.js']
globSync(['**/index.[a-j]*']) // ['src/index.css', 'src/index.js']
globSync(['public/*.(html|ico)']) // ['public/index.html', 'public/favicon.ico']License
Copyright (c) 2021, Thanga Ganapathy (MIT License).