isRelative

function isRelative(path: string): path is string;

The exact complement of isAbsolute: anything that does not start at a root, which includes the empty string.

isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.

Parameters

Parameter	Type	Description
`path`	`string`	The string path to check.

Returns

boolean — true when the value is a relative path; otherwise false.

In TypeScript the guard narrows path to string inside the branch.

Examples

What passes and what does not

isRelative("docs/readme.md"); // => true
isRelative("./a"); // => true
isRelative(""); // => true
isRelative("/var/log"); // => false
isRelative("https://example.com/a"); // => false

Source

src/net/path/isRelative.ts

23 September 2026

This documentation was generated with AI (Claude) from the library's source code.

apps-script-utils 2.1.1 Help