test02/node_modules/@vuepress/plugin-links-check/lib/node/options.d.ts
罗佳鸿 6aa1ebe342
Some checks are pending
部署文档 / deploy-gh-pages (push) Waiting to run
first commit
2024-08-13 10:11:19 +08:00

29 lines
787 B
TypeScript

export interface LinksCheckPluginOptions {
/**
* Whether check dead links in markdown in devServer
*
* 是否在开发服务器检查 Markdown 中的死链
*
* @default true
*/
dev?: boolean;
/**
* Whether check dead links in markdown during build
*
* @description If set to 'error', the build will fail when dead links are found
*
* 是否在构建时检查 Markdown 中的死链
*
* @description 如果设置为 'error',则在发现死链时构建将失败
*
* @default true
*/
build?: boolean | 'error';
/**
* Links to exclude from checking
*
* 检查时需要排除的链接
*/
exclude?: (string | RegExp)[] | ((link: string, isDev: boolean) => boolean);
}