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:
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 (![texto](./some/example.md)).file
: Ruta del archivo donde se encontró el link.
Ejemplo:
Importar el módulo
Consumiendo la promesa
options.validate : false
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.
Last updated