API

Módulo mdLinks.

mdLinks(path, options)

Argumentos:

  • path: Ruta absoluta o relativa al archivo o directorio. Si la ruta pasada es relativa, se resuelve como absoluta al directorio desde donde se invoca.

  • options: Un objeto con las siguientes propiedades:

    • validate: Booleano que determina si se desea validar los links encontrados.

Valor de retorno

La función retorna una promesa (Promise) que resuelve un arreglo (Array) de objetos (Object), donde cada objeto representa un link y contiene las siguientes propiedades:

  • href: URL encontrada.

  • text: Texto que aparecía dentro del link.

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

Caso #1:

const mdLinks = require("marked-links");

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

En consola nos mostraría algo así:

Caso #2:

const mdLinks = require("marked-links");

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

En consola nos mostraría algo así:

Caso #3:

const mdLinks = require("marked-links");

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

En consola nos mostraría algo así:

Observación:

El módulo solo acepta como segundo argumento válido undefined o en su defecto un objeto con la propiedad validate, cuyo valor debe ser booleano.

Caso contrario, generaría las siguientes respuestas:

AnteriorGuía de usoSiguienteCLI

Última actualización