---
description: Módulo mdLinks.
---

# API

**`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í:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97f-WDhSy0a7WhwdiZ%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-04-23.png?alt=media\&token=90564ffd-90cf-402f-a71c-c2010b61054d)

**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í:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97g8smQn5yzat3TIzO%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-12-17.png?alt=media\&token=fc170c5e-500b-4b69-8cbb-30f6ba00b940)

**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í:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97ggi3bZDy5nEdDA1m%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-04-23.png?alt=media\&token=562a97d7-7af8-4440-9dd3-70cd5571845f)

**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:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97jXyKjUJ-jv7EOZyk%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-27-28.png?alt=media\&token=0364f05c-0f9b-437d-b4b6-e09805eee9b3)

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97kDsGARPMqBH759vR%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-30-25.png?alt=media\&token=f0f56aef-8926-489b-b086-7a22dd821086)

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97kwOXWZTYsSDAbJjJ%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-33-34.png?alt=media\&token=7ddce308-23c9-44ed-b549-701a09336cdb)

![Las imágenes corresponden a algunas de las validaciones que realiza el módulo.](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97St4aWvF5tpKJr1hr%2F-M97m1ansi9kRQHBFJ7G%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-35-30.png?alt=media\&token=4c4ee434-7a23-4217-97e7-f216294d9bb6)
