glob - npm Package Compare versions

Comparing version 9.2.1 to 9.3.0

dist/cjs/index-cjs.d.ts

 declare const _default: typeof import("./index.js").glob & {
     glob: typeof import("./index.js").glob;
     globSync: typeof import("./index.js").globSync;
+    sync: typeof import("./index.js").globSync & {
+        stream: typeof import("./index.js").globStreamSync;
+        iterate: typeof import("./index.js").globIterateSync;
+    };
     globStream: typeof import("./index.js").globStream;
+    stream: typeof import("./index.js").globStream & {
+        sync: typeof import("./index.js").globStreamSync;
+    };
     globStreamSync: typeof import("./index.js").globStreamSync;
+    streamSync: typeof import("./index.js").globStreamSync;
     globIterate: typeof import("./index.js").globIterate;
+    iterate: typeof import("./index.js").globIterate & {
+        sync: typeof import("./index.js").globIterateSync;
+    };
     globIterateSync: typeof import("./index.js").globIterateSync;
+    iterateSync: typeof import("./index.js").globIterateSync;
     Glob: typeof import("./glob.js").Glob;
@@ -16,6 +28,18 @@ hasMagic: (pattern: string | string[], options?: import("./glob.js").GlobOptions) => boolean;
         globSync: typeof import("./index.js").globSync;
+        sync: typeof import("./index.js").globSync & {
+            stream: typeof import("./index.js").globStreamSync;
+            iterate: typeof import("./index.js").globIterateSync;
+        };
         globStream: typeof import("./index.js").globStream;
+        stream: typeof import("./index.js").globStream & {
+            sync: typeof import("./index.js").globStreamSync;
+        };
         globStreamSync: typeof import("./index.js").globStreamSync;
+        streamSync: typeof import("./index.js").globStreamSync;
         globIterate: typeof import("./index.js").globIterate;
+        iterate: typeof import("./index.js").globIterate & {
+            sync: typeof import("./index.js").globIterateSync;
+        };
         globIterateSync: typeof import("./index.js").globIterateSync;
+        iterateSync: typeof import("./index.js").globIterateSync;
         Glob: typeof import("./glob.js").Glob;
@@ -29,6 +53,18 @@ hasMagic: (pattern: string | string[], options?: import("./glob.js").GlobOptions) => boolean;
         globSync: typeof import("./index.js").globSync;
+        sync: typeof import("./index.js").globSync & {
+            stream: typeof import("./index.js").globStreamSync;
+            iterate: typeof import("./index.js").globIterateSync;
+        };
         globStream: typeof import("./index.js").globStream;
+        stream: typeof import("./index.js").globStream & {
+            sync: typeof import("./index.js").globStreamSync;
+        };
         globStreamSync: typeof import("./index.js").globStreamSync;
+        streamSync: typeof import("./index.js").globStreamSync;
         globIterate: typeof import("./index.js").globIterate;
+        iterate: typeof import("./index.js").globIterate & {
+            sync: typeof import("./index.js").globIterateSync;
+        };
         globIterateSync: typeof import("./index.js").globIterateSync;
+        iterateSync: typeof import("./index.js").globIterateSync;
         Glob: typeof import("./glob.js").Glob;
@@ -35,0 +71,0 @@ hasMagic: (pattern: string | string[], options?: import("./glob.js").GlobOptions) => boolean;

dist/cjs/index.d.ts

@@ -40,2 +40,9 @@ import Minipass from 'minipass';
 /**
+ * Return a sync iterator for walking glob pattern matches.
+ */
+export declare function globIterateSync(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Generator<string, void, void>;
+export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Generator<Path, void, void>;
+export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Generator<string, void, void>;
+export declare function globIterateSync(pattern: string | string[], options: GlobOptions): Generator<Path, void, void> | Generator<string, void, void>;
+/**
  * Return an async iterator for walking glob pattern matches.
@@ -47,9 +54,14 @@ */
 export declare function globIterate(pattern: string | string[], options: GlobOptions): AsyncGenerator<Path, void, void> | AsyncGenerator<string, void, void>;
-/**
- * Return a sync iterator for walking glob pattern matches.
- */
-export declare function globIterateSync(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Generator<string, void, void>;
-export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Generator<Path, void, void>;
-export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Generator<string, void, void>;
-export declare function globIterateSync(pattern: string | string[], options: GlobOptions): Generator<Path, void, void> | Generator<string, void, void>;
+export declare const streamSync: typeof globStreamSync;
+export declare const stream: typeof globStream & {
+    sync: typeof globStreamSync;
+};
+export declare const iterateSync: typeof globIterateSync;
+export declare const iterate: typeof globIterate & {
+    sync: typeof globIterateSync;
+};
+export declare const sync: typeof globSync & {
+    stream: typeof globStreamSync;
+    iterate: typeof globIterateSync;
+};
 export { escape, unescape } from 'minimatch';
@@ -64,6 +76,18 @@ export { Glob } from './glob.js';
     globSync: typeof globSync;
+    sync: typeof globSync & {
+        stream: typeof globStreamSync;
+        iterate: typeof globIterateSync;
+    };
     globStream: typeof globStream;
+    stream: typeof globStream & {
+        sync: typeof globStreamSync;
+    };
     globStreamSync: typeof globStreamSync;
+    streamSync: typeof globStreamSync;
     globIterate: typeof globIterate;
+    iterate: typeof globIterate & {
+        sync: typeof globIterateSync;
+    };
     globIterateSync: typeof globIterateSync;
+    iterateSync: typeof globIterateSync;
     Glob: typeof Glob;
@@ -70,0 +94,0 @@ hasMagic: (pattern: string | string[], options?: GlobOptions) => boolean;

dist/cjs/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasMagic = exports.Glob = exports.unescape = exports.escape = exports.globIterateSync = exports.globIterate = exports.glob = exports.globSync = exports.globStream = exports.globStreamSync = void 0;
+exports.hasMagic = exports.Glob = exports.unescape = exports.escape = exports.sync = exports.iterate = exports.iterateSync = exports.stream = exports.streamSync = exports.globIterate = exports.globIterateSync = exports.glob = exports.globSync = exports.globStream = exports.globStreamSync = void 0;
 const minimatch_1 = require("minimatch");
@@ -23,2 +23,6 @@ const glob_js_1 = require("./glob.js");
 exports.glob = glob;
+function globIterateSync(pattern, options = {}) {
+    return new glob_js_1.Glob(pattern, options).iterateSync();
+}
+exports.globIterateSync = globIterateSync;
 function globIterate(pattern, options = {}) {
@@ -28,6 +32,13 @@ return new glob_js_1.Glob(pattern, options).iterate();
 exports.globIterate = globIterate;
-function globIterateSync(pattern, options = {}) {
-    return new glob_js_1.Glob(pattern, options).iterateSync();
-}
-exports.globIterateSync = globIterateSync;
+// aliases: glob.sync.stream() glob.stream.sync() glob.sync() etc
+exports.streamSync = globStreamSync;
+exports.stream = Object.assign(globStream, { sync: globStreamSync });
+exports.iterateSync = globIterateSync;
+exports.iterate = Object.assign(globIterate, {
+    sync: globIterateSync,
+});
+exports.sync = Object.assign(globSync, {
+    stream: globStreamSync,
+    iterate: globIterateSync,
+});
 /* c8 ignore start */
@@ -45,6 +56,11 @@ var minimatch_2 = require("minimatch");
     globSync,
+    sync: exports.sync,
     globStream,
+    stream: exports.stream,
     globStreamSync,
+    streamSync: exports.streamSync,
     globIterate,
+    iterate: exports.iterate,
     globIterateSync,
+    iterateSync: exports.iterateSync,
     Glob: glob_js_1.Glob,
@@ -51,0 +67,0 @@ hasMagic: has_magic_js_1.hasMagic,

dist/mjs/index.d.ts

@@ -40,2 +40,9 @@ import Minipass from 'minipass';
 /**
+ * Return a sync iterator for walking glob pattern matches.
+ */
+export declare function globIterateSync(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Generator<string, void, void>;
+export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Generator<Path, void, void>;
+export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Generator<string, void, void>;
+export declare function globIterateSync(pattern: string | string[], options: GlobOptions): Generator<Path, void, void> | Generator<string, void, void>;
+/**
  * Return an async iterator for walking glob pattern matches.
@@ -47,9 +54,14 @@ */
 export declare function globIterate(pattern: string | string[], options: GlobOptions): AsyncGenerator<Path, void, void> | AsyncGenerator<string, void, void>;
-/**
- * Return a sync iterator for walking glob pattern matches.
- */
-export declare function globIterateSync(pattern: string | string[], options?: GlobOptionsWithFileTypesUnset | undefined): Generator<string, void, void>;
-export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesTrue): Generator<Path, void, void>;
-export declare function globIterateSync(pattern: string | string[], options: GlobOptionsWithFileTypesFalse): Generator<string, void, void>;
-export declare function globIterateSync(pattern: string | string[], options: GlobOptions): Generator<Path, void, void> | Generator<string, void, void>;
+export declare const streamSync: typeof globStreamSync;
+export declare const stream: typeof globStream & {
+    sync: typeof globStreamSync;
+};
+export declare const iterateSync: typeof globIterateSync;
+export declare const iterate: typeof globIterate & {
+    sync: typeof globIterateSync;
+};
+export declare const sync: typeof globSync & {
+    stream: typeof globStreamSync;
+    iterate: typeof globIterateSync;
+};
 export { escape, unescape } from 'minimatch';
@@ -64,6 +76,18 @@ export { Glob } from './glob.js';
     globSync: typeof globSync;
+    sync: typeof globSync & {
+        stream: typeof globStreamSync;
+        iterate: typeof globIterateSync;
+    };
     globStream: typeof globStream;
+    stream: typeof globStream & {
+        sync: typeof globStreamSync;
+    };
     globStreamSync: typeof globStreamSync;
+    streamSync: typeof globStreamSync;
     globIterate: typeof globIterate;
+    iterate: typeof globIterate & {
+        sync: typeof globIterateSync;
+    };
     globIterateSync: typeof globIterateSync;
+    iterateSync: typeof globIterateSync;
     Glob: typeof Glob;
@@ -70,0 +94,0 @@ hasMagic: (pattern: string | string[], options?: GlobOptions) => boolean;

dist/mjs/index.js

@@ -16,8 +16,19 @@ import { escape, unescape } from 'minimatch';
 }
+export function globIterateSync(pattern, options = {}) {
+    return new Glob(pattern, options).iterateSync();
+}
 export function globIterate(pattern, options = {}) {
     return new Glob(pattern, options).iterate();
 }
-export function globIterateSync(pattern, options = {}) {
-    return new Glob(pattern, options).iterateSync();
-}
+// 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 */
@@ -31,6 +42,11 @@ export { escape, unescape } from 'minimatch';
     globSync,
+    sync,
     globStream,
+    stream,
     globStreamSync,
+    streamSync,
     globIterate,
+    iterate,
     globIterateSync,
+    iterateSync,
     Glob,
@@ -37,0 +53,0 @@ hasMagic,

package.json

@@ -5,3 +5,3 @@ {
   "description": "the most correct and second fastest glob implementation in JavaScript",
-  "version": "9.2.1",
+  "version": "9.3.0",
   "repository": {
@@ -8,0 +8,0 @@ "type": "git",

README.md

@@ -32,2 +32,3 @@ # Glob
 // or default export is fine too, just returns the glob function
+// with all the aliases attached.
 import glob from 'glob'
@@ -157,6 +158,8 @@ // or using commonjs
 
-## `globSync(pattern: string, options?: GlobOptions) => string[] | Path[]`
+## `globSync(pattern: string | string[], options?: GlobOptions) => string[] | Path[]`
 
 Synchronous form of `glob()`.
 
+Alias: `glob.sync()`
+
 ## `globIterate(pattern: string | string[], options?: GlobOptions) => AsyncGenerator<string>`
@@ -166,2 +169,4 @@
 
+Alias: `glob.iterate()`
+
 ## `globIterateSync(pattern: string | string[], options?: GlobOptions) => Generator<string>`
@@ -171,2 +176,4 @@
 
+Alias: `glob.iterate.sync()`, `glob.sync.iterate()`
+
 ## `globStream(pattern: string | string[], options?: GlobOptions) => Minipass<string | Path>`
@@ -177,2 +184,4 @@
 
+Alias: `glob.stream()`
+
 ## `globStreamSync(pattern: string | string[], options?: GlobOptions) => Minipass<string | Path>`
@@ -185,2 +194,4 @@
 
+Alias: `glob.stream.sync()`, `glob.sync.stream()`
+
 ## `hasMagic(pattern: string | string[], options?: GlobOptions) => boolean`
@@ -187,0 +198,0 @@

No alert changes

Improved metrics

Total package byte prevSize

302858

increased by1.99%

Lines of code

4030

increased by2.99%

Number of lines in readme file

1084

increased by1.03%

No dependency changes