Logo for jsDocs.io

walk-sync

  • Version 3.0.0
  • Published
  • 20 kB
  • 4 dependencies
  • MIT license

Install

npm i walk-sync
yarn add walk-sync
pnpm add walk-sync

Overview

Get an array of recursive directory contents

Index

Functions

Classes

Interfaces

Functions

function entries

entries: (
    baseDir: string,
    inputOptions?: Options | (string | IMinimatch)[]
) => Entry[];

    function walkSync

    walkSync: typeof walkSync;

      Classes

      class Entry

      class Entry {}

        constructor

        constructor(
            relativePath: string,
            basePath: string,
            mode: number,
            size: number,
            mtime: number
        );

          property basePath

          basePath: string;

            property fullPath

            readonly fullPath: string;

              property mode

              mode: number;

                property mtime

                mtime: number;

                  property relativePath

                  relativePath: string;

                    property size

                    size: number;

                      method isDirectory

                      isDirectory: () => boolean;

                        Interfaces

                        interface Options

                        interface Options {}

                          property directories

                          directories?: boolean;

                            property fs

                            fs?: typeof fsNode;

                              property globOptions

                              globOptions?: MinimatchOptions;

                                property globs

                                globs?: (string | IMinimatch)[];

                                  property ignore

                                  ignore?: (string | IMinimatch)[];

                                    property includeBasePath

                                    includeBasePath?: boolean;

                                      Package Files (1)

                                      Dependencies (4)

                                      Dev Dependencies (8)

                                      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/walk-sync.

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