requireRelative

function requireRelative(path: unknown, message: string = "Expected a relative path."): string;

Le complément exact de isAbsolute: tout ce qui ne part pas d'une racine, y compris la chaîne vide.

isX et nonX répondent à une question sans jamais interrompre le flot ; requireX et requireNonX rendent la valeur ou lèvent. Le schéma est expliqué dans Conventions de validation.

Paramètres

Paramètre	Type	Description
`path`	`unknown`	The value to validate as a relative path.
`message` (facultatif) `= "Expected a relative path."`	`string`	Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

string — la même valeur, typée comme un chemin relatif.

Exceptions

Exception	Condition
`IllegalArgumentException`	la valeur n'est pas un chemin relatif.

Exemples

Ce qui passe et ce qui ne passe pas

requireRelative("docs/readme.md"); // => "docs/readme.md"
requireRelative("./a"); // => "./a"
requireRelative("/var/log"); // throws IllegalArgumentException
requireRelative("https://example.com/a"); // throws IllegalArgumentException

Voir aussi

Code source

src/net/path/requireRelative.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.