Метод format

Метод format возвращает путь к файлу в виде строкового значения из объекта, указанного в параметре. Объект включает следующие ключи dir - имя папки, root - корневой путь, base - файл с расширением, name - имя фала, ext - расширение. При применении метода можно игнорировать некоторые ключи, но при этом в объекте должна быть информация о папки или файле. В зависимости от платформы, меняется синтаксис пути в ключах. Например, для ключа root в POSIX путь записывается как '/', а для Windows - 'C:\\path\\dir''.

Синтаксис

path.format({папка, корневой путь, файл с расширением, имя фала, расширение});

Пример

Давайте узнаем строковый путь к файлу для Windows, при этом мы игнорируем корневой путь и указываем путь к директории, имя и расширение файла:

import path from 'path';

console.log(path.format({
	root: '/ignored',
	dir: '\\dir',
	name: 'file',
	ext: '.txt',
}));

Результат выполненного кода:

'\dir\file.txt'

Смотрите также

метод parse,
который преобразует путь из строки в объект
метод isAbsolute,
который проверяет абсолютный путь к файлу