Logo for jsDocs.io

is-path-in-cwd

  • Version 4.0.0
  • Published
  • 3.15 kB
  • 1 dependency
  • MIT license

Install

npm i is-path-in-cwd
yarn add is-path-in-cwd
pnpm add is-path-in-cwd

Overview

Check if a path is in the current working directory

Index

Functions

Functions

function isPathInCwd

isPathInCwd: (path: string) => boolean;

  • Check if a path is in the [current working directory](https://en.wikipedia.org/wiki/Working_directory).

    Example 1

    import isPathInCwd from 'is-path-in-cwd';
    

    isPathInCwd('unicorn');
    //=> true
    

    isPathInCwd('../rainbow');
    //=> false
    

    isPathInCwd('.');
    //=> false

Package Files (1)

Dependencies (1)

Dev Dependencies (3)

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/is-path-in-cwd.

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