Merge pull request #398 from mrmlnc/ISSUE-397_glob_aliases

ISSUE-397: Provide glob, globSync and globSteam aliases

README.md

@@ -142,6 +142,8 @@ npm install fast-glob
 
 ```js
 fg(patterns, [options])
+fg.async(patterns, [options])
+fg.glob(patterns, [options])
 ```
 
 Returns a `Promise` with an array of matching entries.
@@ -158,6 +160,7 @@ const entries = await fg(['.editorconfig', '**/index.js'], { dot: true });
 
 ```js
 fg.sync(patterns, [options])
+fg.globSync(patterns, [options])
 ```
 
 Returns an array of matching entries.
@@ -174,6 +177,7 @@ const entries = fg.sync(['.editorconfig', '**/index.js'], { dot: true });
 
 ```js
 fg.stream(patterns, [options])
+fg.globStream(patterns, [options])
 ```
 
 Returns a [`ReadableStream`][node_js_stream_readable_streams] when the `data` event will be emitted with matching entry.

src/index.spec.ts

@@ -5,6 +5,12 @@ import { EntryItem, ErrnoException } from './types';
 import * as fg from '.';
 
 describe('Package', () => {
+	describe('.globSync', () => {
+		it('must be an alias for the .sync method', () => {
+			assert.strictEqual(fg.globSync, fg.sync);
+		});
+	});
+
 	describe('.sync', () => {
 		it('should throw an error when input values can not pass validation', () => {
 			const message = 'Patterns must be a string (non empty) or an array of strings';
@@ -52,6 +58,12 @@ describe('Package', () => {
 		});
 	});
 
+	describe('.glob', () => {
+		it('must be an alias for the .sync method', () => {
+			assert.strictEqual(fg.glob, fg.async);
+		});
+	});
+
 	describe('.async', () => {
 		it('should throw an error when input values can not pass validation', async () => {
 			const message = 'Patterns must be a string (non empty) or an array of strings';
@@ -99,6 +111,12 @@ describe('Package', () => {
 		});
 	});
 
+	describe('.globStream', () => {
+		it('must be an alias for the .sync method', () => {
+			assert.strictEqual(fg.globStream, fg.stream);
+		});
+	});
+
 	describe('.stream', () => {
 		it('should throw an error when input values can not pass validation', () => {
 			const message = 'Patterns must be a string (non empty) or an array of strings';

src/index.ts

@@ -32,6 +32,10 @@ namespace FastGlob {
 	export type Pattern = PatternInternal;
 	export type FileSystemAdapter = FileSystemAdapterInternal;
 
+	export const glob = FastGlob;
+	export const globSync = sync;
+	export const globStream = stream;
+
 	export const async = FastGlob;
 
 	export function sync(source: PatternInternal | PatternInternal[], options: OptionsInternal & EntryObjectPredicate): EntryInternal[];