Function: isPath()

isPath(inp): boolean

Tell whether a string is written as an explicit file system path, by its syntax only (the path is not looked up): an absolute POSIX path (/usr/bin), a path relative to the current or the parent directory (./a, ../a/b), or a Windows path starting with \ or with a drive and `` (C:\Windows). A bare relative path (a/b, file.txt), a home path (~/x), a drive with / (C:/x), a UNC path (\\server\share) and a URL are not, nor a path with a character among : * ? " < > | or a line break after its start.

Parameters

inp

PathLike

The value to test: a string, or a Buffer (read as its string, as node:fs accepts a Buffer path); a URL gives false.

Returns

boolean

true when the value has the syntax of an explicit path, false otherwise.

Example

import {isPath} from 'lakutata/utils'

console.log(isPath('/var/log'), isPath('./config.json'), isPath('config.json'), isPath('https://example.com'))
//true true false false