Logo for jsDocs.io

@nodelib/fs.walk

  • Version 3.0.1
  • Published
  • 29.8 kB
  • 2 dependencies
  • MIT license

Install

npm i @nodelib/fs.walk
yarn add @nodelib/fs.walk
pnpm add @nodelib/fs.walk

Overview

A library for efficiently walking a directory recursively

Index

Functions

Classes

Interfaces

Type Aliases

Namespaces

Functions

function walk

walk: typeof walk;

    function walkStream

    walkStream: (
        directory: string,
        optionsOrSettings?: Options | Settings
    ) => Readable;

      function walkSync

      walkSync: (directory: string, optionsOrSettings?: Options | Settings) => Entry[];

        Classes

        class Settings

        class Settings {}

          constructor

          constructor(options?: Options);

            property basePath

            readonly basePath?: string;

              property concurrency

              readonly concurrency: number;

                property deepFilter

                readonly deepFilter: DeepFilterFunction;

                  property entryFilter

                  readonly entryFilter: EntryFilterFunction;

                    property errorFilter

                    readonly errorFilter: ErrorFilterFunction;

                      property fsScandirSettings

                      readonly fsScandirSettings: fsScandir.Settings;

                        property pathSegmentSeparator

                        readonly pathSegmentSeparator: string;

                          property signal

                          readonly signal?: AbortSignal;

                            Interfaces

                            interface Options

                            interface Options {}

                              property basePath

                              basePath?: string;

                                property concurrency

                                concurrency?: number;

                                  property deepFilter

                                  deepFilter?: DeepFilterFunction;

                                    property entryFilter

                                    entryFilter?: EntryFilterFunction;

                                      property errorFilter

                                      errorFilter?: ErrorFilterFunction;
                                        followSymbolicLinks?: boolean;

                                          property fs

                                          fs?: Partial<fsScandir.FileSystemAdapter>;

                                            property pathSegmentSeparator

                                            pathSegmentSeparator?: string;

                                              property signal

                                              signal?: AbortSignal;

                                                property stats

                                                stats?: boolean;
                                                  throwErrorOnBrokenSymbolicLink?: boolean;

                                                    Type Aliases

                                                    type AsyncCallback

                                                    type AsyncCallback = (error: ErrnoException | null, entries: Entry[]) => void;

                                                      type DeepFilterFunction

                                                      type DeepFilterFunction = FilterFunction<Entry>;

                                                        type Entry

                                                        type Entry = scandir.Entry;

                                                          type EntryFilterFunction

                                                          type EntryFilterFunction = FilterFunction<Entry>;

                                                            type ErrorFilterFunction

                                                            type ErrorFilterFunction = FilterFunction<ErrnoException>;

                                                              Namespaces

                                                              namespace walk

                                                              namespace walk {}

                                                                Package Files (5)

                                                                Dependencies (2)

                                                                Dev Dependencies (2)

                                                                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/@nodelib/fs.walk.

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