Skip to content

shinnn/node-is-path-from-ancestor

Repository files navigation

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

About

Check if a given path starts with parent directory reference

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published