Logo for jsDocs.io

fast-glob

  • Version 3.3.2
  • Published
  • 96.7 kB
  • 5 dependencies
  • MIT license

Install

npm i fast-glob
yarn add fast-glob
pnpm add fast-glob

Overview

It's a very fast and efficient glob library for Node.js

Index

Variables

Functions

Type Aliases

Namespaces

Variables

variable async

const async: typeof FastGlob;

    variable glob

    const glob: typeof FastGlob;

      variable globStream

      const globStream: (
          source: string | string[],
          options?: OptionsInternal
      ) => NodeJS.ReadableStream;

        variable globSync

        const globSync: {
            (
                source: string | string[],
                options: OptionsInternal & EntryObjectPredicate
            ): fsWalk.Entry[];
            (source: string | string[], options?: OptionsInternal): string[];
        };

          Functions

          function convertPathToPattern

          convertPathToPattern: (source: string) => PatternInternal;

            function escapePath

            escapePath: (source: string) => PatternInternal;

              function FastGlob

              FastGlob: typeof FastGlob;

                function generateTasks

                generateTasks: (
                    source: PatternInternal | PatternInternal[],
                    options?: OptionsInternal
                ) => Task[];

                  function isDynamicPattern

                  isDynamicPattern: (
                      source: PatternInternal,
                      options?: OptionsInternal
                  ) => boolean;

                    function stream

                    stream: (
                        source: PatternInternal | PatternInternal[],
                        options?: OptionsInternal
                    ) => NodeJS.ReadableStream;

                      function sync

                      sync: {
                          (
                              source: PatternInternal | PatternInternal[],
                              options: OptionsInternal & EntryObjectPredicate
                          ): EntryInternal[];
                          (source: string | string[], options?: OptionsInternal): string[];
                      };

                        Type Aliases

                        type Entry

                        type Entry = EntryInternal;

                          type FileSystemAdapter

                          type FileSystemAdapter = FileSystemAdapterInternal;

                            type Options

                            type Options = OptionsInternal;

                              type Pattern

                              type Pattern = PatternInternal;

                                type Task

                                type Task = taskManager.Task;

                                  Namespaces

                                  namespace posix

                                  namespace posix {}

                                    function convertPathToPattern

                                    convertPathToPattern: (source: string) => PatternInternal;

                                      function escapePath

                                      escapePath: (source: string) => PatternInternal;

                                        namespace win32

                                        namespace win32 {}

                                          function convertPathToPattern

                                          convertPathToPattern: (source: string) => PatternInternal;

                                            function escapePath

                                            escapePath: (source: string) => PatternInternal;

                                              Package Files (1)

                                              Dependencies (5)

                                              Dev Dependencies (21)

                                              Peer Dependencies (0)

                                              No peer dependencies.

                                              Badge

                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/fast-glob.

                                              • Markdown
                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/fast-glob)
                                              • HTML
                                                <a href="https://www.jsdocs.io/package/fast-glob"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>