Método Node.js path.format()

El método path.format() se usa para devolver una string de ruta desde el objeto de ruta dado. El método tiene algunas reglas en las que una propiedad de ruta tiene más prioridad sobre otra:

  • El parámetro «raíz» del objeto de ruta se ignora si se proporciona el parámetro «dir».
  • Los parámetros «ext» y «name» del objeto de ruta se ignoran si se proporciona el parámetro «base».

Sintaxis:

path.format( pathObject )

Parámetros: esta función acepta un solo parámetro pathObject que contiene los detalles de la ruta. Tiene los siguientes parámetros:

  • dir: especifica el nombre del directorio del objeto de ruta.
  • root: Especifica la raíz del objeto ruta.
  • base: Especifica la base del objeto de ruta.
  • name: Especifica el nombre del archivo del objeto de la ruta.
  • ext: especifica la extensión de archivo del objeto de ruta.

Valor de retorno: devuelve una string de ruta del objeto de ruta proporcionado.

Los siguientes programas ilustran el método path.format() en Node.js:

Ejemplo 1: en POSIX

// Import the path module
const path = require('path');
  
// CASE 1
// If "dir", "root" and "base" are all given,
// "root" is ignored.
let path1 = path.format({
    root: "/ignored/root/",
    dir: "/home/user/personal",
    base: "details.txt",
});
console.log("Path 1:", path1);
  
// CASE 2
// If "dir" is not specified then "root" will be used 
// If only "root" is provided
// platform separator will not be included.
// "ext" will be ignored.
let path2 = path.format({
    root: "/",
    base: "game.dat",
    ext: ".noextension",
});
console.log("Path 2:", path2);
  
// CASE 3
// If "base" is not specified
// "name" and "ext" will be used 
let path3 = path.format({
    root: "/images/",
    name: "image",
    ext: ".jpg",
});
console.log("Path 3:", path3);

Producción:

Path 1: /home/user/personal/details.txt
Path 2: /game.dat
Path 3: /images/image.jpg

Ejemplo 2: en Windows

// Import the path module
const path = require('path');
  
// CASE 1
// If "dir", "root" and "base" are all given,
// "root" is ignored.
let path1 = path.format({
    root: "C:\\ignored\\root",
    dir: "website\\dist",
    base: "index.html",
});
console.log("Path 1:", path1);
  
// CASE 2
// If "dir" is not specified then "root"
// will be used 
// If only "root" is provided platform
// separator will not be included.
// "ext" will be ignored.
let path2 = path.format({
    root: "C:\\",
    base: "style.css",
    ext: ".ignored",
});
console.log("Path 2:", path2);
  
// CASE 3
// If "base" is not specified
// "name" and "ext" will be used 
let path3 = path.format({
    root: "website\\",
    name: "main",
    ext: ".js",
});
console.log("Path 3:", path3);

Producción:

Path 1: website\dist\index.html
Path 2: C:\style.css
Path 3: website\main.js

Referencia: https://nodejs.org/api/path.html#path_path_format_pathobject

Publicación traducida automáticamente

Artículo escrito por sayantanm19 y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *