• Version 3.0.6
  • Published
  • 5.61 kB
  • 1 dependency
  • MIT license


npm i @types/klaw
yarn add @types/klaw
pnpm add @types/klaw


TypeScript definitions for klaw



namespace klaw

module 'klaw' {}

    function K

    K: (root: string, options?: K.Options) => K.Walker;

      interface Item

      interface Item {}

        property path

        path: string;

          property stats

          stats: fs.Stats;

            interface Options

            interface Options extends ReadableOptions {}

              property depthLimit

              depthLimit?: number | undefined;

                property filter

                filter?: ((path: string) => boolean) | undefined;

                  property fs

                  fs?: any;

                    property pathSorter

                    pathSorter?: ((pathA: string, pathB: string) => number) | undefined;
                      preserveSymlinks?: boolean | undefined;

                        property queueMethod

                        queueMethod?: QueueMethod | undefined;

                          interface Walker

                          interface Walker extends Readable, AsyncIterable<Item> {}

                            method [Symbol.asyncIterator]

                            [Symbol.asyncIterator]: () => AsyncIterableIterator<Item>;

                              method on

                              on: {
                              (event: Event, listener: Function): this;
                              (event: 'close', listener: () => void): this;
                              (event: 'data', listener: (item: Item) => void): this;
                              (event: 'end', listener: () => void): this;
                              (event: 'readable', listener: () => void): this;
                              (event: 'error', listener: (err: Error) => void): this;

                                method read

                                read: () => Item;

                                  type Event

                                  type Event = 'close' | 'data' | 'end' | 'error' | 'pause' | 'readable' | 'resume';

                                    type QueueMethod

                                    type QueueMethod = 'shift' | 'pop';

                                      Package Files (1)

                                      Dependencies (1)

                                      Dev Dependencies (0)

                                      No dev dependencies.

                                      Peer Dependencies (0)

                                      No peer dependencies.


                                      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/@types/klaw.

                                      • Markdown
                                      • HTML
                                        <a href="https://www.jsdocs.io/package/@types/klaw"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>