is-path-from-ancestor

2.0.3 • Public • Published

is-path-from-ancestor

npm version Build Status Coverage Status

A Node.js module to check if a given path starts with parent directory reference

const isPathFromAncestor = require('is-path-from-ancestor');
 
// On POSIX
isPathFromAncestor('../foo'); //=> true
isPathFromAncestor('foo'); //=> false
 
// On Windows
isPathFromAncestor('..\\foo'); //=> true

Installation

Use npm.

npm install is-path-from-ancestor

API

const isPathFromAncestor = require('is-path-from-ancestor');

isPathFromAncestor(path)

path: string
Return: boolean

It returns true if path starts with ../ (POSIX) or ..\\ (Windows), otherwise returns false.

It normalizes the path before checking.

// On POSIX
 
isPathFromAncestor('foo/../../'); //=> true
isPathFromAncestor('foo/../'); //=> false

License

Creative Commons Zero v1.0 Universal

Package Sidebar

Install

npm i is-path-from-ancestor

Weekly Downloads

1

Version

2.0.3

License

CC0-1.0

Unpacked Size

2.74 kB

Total Files

3

Last publish

Collaborators

  • shinnn