Logo for jsDocs.io

valid-directory

  • Version 4.9.0
  • Published
  • 42 kB
  • 2 dependencies
  • Artistic-2.0 license

Install

npm i valid-directory
yarn add valid-directory
pnpm add valid-directory

Overview

Check whether or not a directory and its descendants are valid

Index

Functions

Type Aliases

Functions

function validate

validate: (fullPath: string) => Promise<ValidateResult>;

  • Validate a directory and its descendants

Type Aliases

type Paths

type Paths = string[];

  • Array of paths that are invalid

type ValidateResult

type ValidateResult =
    | [valid: false, invalidRelativePaths: Paths, relativePaths: Paths]
    | [valid: true, invalidRelativePaths: [], relativePaths: Paths];

  • Whether or not the directory was valid

Package Files (1)

Dependencies (2)

Dev Dependencies (15)

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/valid-directory.

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