diff --git a/README.md b/README.md index 85112928..353c5951 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ const { } = require('glob') // or default export is fine too, just returns the glob function +// with all the aliases attached. import glob from 'glob' // or using commonjs const glob = require('glob') @@ -157,19 +158,27 @@ for full options field desciptions. Synchronous form of `glob()`. +Alias: `glob.sync()` + ## `globIterate(pattern: string | string[], options?: GlobOptions) => AsyncGenerator` Return an async iterator for walking glob pattern matches. +Alias: `glob.iterate()` + ## `globIterateSync(pattern: string | string[], options?: GlobOptions) => Generator` Return a sync iterator for walking glob pattern matches. +Alias: `glob.iterate.sync()`, `glob.sync.iterate()` + ## `globStream(pattern: string | string[], options?: GlobOptions) => Minipass` Return a stream that emits all the strings or `Path` objects and then emits `end` when completed. +Alias: `glob.stream()` + ## `globStreamSync(pattern: string | string[], options?: GlobOptions) => Minipass` Syncronous form of `globStream()`. Will read all the matches as @@ -177,6 +186,8 @@ fast as you consume them, even all in a single tick if you consume them immediately, but will still respond to backpressure if they're not consumed immediately. +Alias: `glob.stream.sync()`, `glob.sync.stream()` + ## `hasMagic(pattern: string | string[], options?: GlobOptions) => boolean` Returns `true` if the provided pattern contains any "magic" glob diff --git a/changelog.md b/changelog.md index fe432642..55c0129a 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,10 @@ # changeglob +## 9.3 + +- Add aliases for methods. `glob.sync`, `glob.stream`, + `glob.stream.sync`, etc. + ## 9.2 - Support using a custom fs object, which is passed to PathScurry diff --git a/src/index.ts b/src/index.ts index 2ba37e2a..27e04f90 100644 --- a/src/index.ts +++ b/src/index.ts @@ -121,57 +121,69 @@ export async function glob( } /** - * Return an async iterator for walking glob pattern matches. + * Return a sync iterator for walking glob pattern matches. */ -export function globIterate( +export function globIterateSync( pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined -): AsyncGenerator -export function globIterate( +): Generator +export function globIterateSync( pattern: string | string[], options: GlobOptionsWithFileTypesTrue -): AsyncGenerator -export function globIterate( +): Generator +export function globIterateSync( pattern: string | string[], options: GlobOptionsWithFileTypesFalse -): AsyncGenerator -export function globIterate( +): Generator +export function globIterateSync( pattern: string | string[], options: GlobOptions -): AsyncGenerator | AsyncGenerator -export function globIterate( +): Generator | Generator +export function globIterateSync( pattern: string | string[], options: GlobOptions = {} ) { - return new Glob(pattern, options).iterate() + return new Glob(pattern, options).iterateSync() } /** - * Return a sync iterator for walking glob pattern matches. + * Return an async iterator for walking glob pattern matches. */ -export function globIterateSync( +export function globIterate( pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined -): Generator -export function globIterateSync( +): AsyncGenerator +export function globIterate( pattern: string | string[], options: GlobOptionsWithFileTypesTrue -): Generator -export function globIterateSync( +): AsyncGenerator +export function globIterate( pattern: string | string[], options: GlobOptionsWithFileTypesFalse -): Generator -export function globIterateSync( +): AsyncGenerator +export function globIterate( pattern: string | string[], options: GlobOptions -): Generator | Generator -export function globIterateSync( +): AsyncGenerator | AsyncGenerator +export function globIterate( pattern: string | string[], options: GlobOptions = {} ) { - return new Glob(pattern, options).iterateSync() + return new Glob(pattern, options).iterate() } +// aliases: glob.sync.stream() glob.stream.sync() glob.sync() etc +export const streamSync = globStreamSync +export const stream = Object.assign(globStream, { sync: globStreamSync }) +export const iterateSync = globIterateSync +export const iterate = Object.assign(globIterate, { + sync: globIterateSync, +}) +export const sync = Object.assign(globSync, { + stream: globStreamSync, + iterate: globIterateSync, +}) + /* c8 ignore start */ export { escape, unescape } from 'minimatch' export { Glob } from './glob.js' @@ -189,10 +201,15 @@ export type { MatchStream } from './walker.js' export default Object.assign(glob, { glob, globSync, + sync, globStream, + stream, globStreamSync, + streamSync, globIterate, + iterate, globIterateSync, + iterateSync, Glob, hasMagic, escape,