API md-links

API md-links(path, options) - <Promise>

• El módulo implementa soporte para archivo individual.

• El módulo implementa soporte para directorios.

• El módulo implementa options.validate.

El módulo se importa en otros scripts de Node.js ofreciendo la siguiente interfaz:

@omairapalacios/md-links(path, options)

Argumentos

• path: (string) Ruta absoluta o relativa al archivo o directorio de donde se invoca .

• options: (objeto) con las siguiente propiedad :

  • validate: (booleano) que determina si se desea validar los links encontrados.

  false : retorna un array de objetos con 3 propiedades :

  [{ href, path, text }]

  true : valida links , retorna propiedades adicionales [{ href, path, text, status, message }]

Valor de retorno

El modulo retorna una promesa (Promise) que se resuelve en un arreglo (Array) de objetos , donde cada objeto representa un link y contiene las siguientes propiedades:

• href: URL encontrada.

• text: Texto que aparece dentro del link ().

• file: Ruta del archivo donde se encontró el link.

Ejemplo:

• Importar el módulo

const mdLinks = require("@omairapalacios/md-links");

• Consumiendo la promesa

options.validate : false

mdLinks("./some/example.md", { validate: false })
  .then((links) => console.log (links))
  .catch((error) => console.log(error));

[{ href: "https://jestjs.io/",
   path: "./some/example.md",
   text: "Testing von jest"
},
{ href: "https://linkbad.com/",
   path: "./some/example.md",
   text: "link bad"
}]

options.validate : true

El módulo hace una petición HTTP para checkear si el link funciona o no. Se agregan 2 propiedades al objeto para indicar la respuesta recibida.

status: código de respuesta HTTP.

message: texto corto que contrasta según el codigo de respuesta.

mdlinks("./some/example.md", { validate: true })
  .then((links) => console.log (links))
  .catch((error) => console.log(error));

[{ href: "https://jestjs.io/",
   path: "./some/example.md",
   text: "Testing von jest",
   status: 200,
   message: 'OK'
},
{ href: "https://linkbad.com/",
   path: "./some/example.md",
   text: "link bad",
   status: 400,
   message: 'Fail'
   }
]