Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-23 01:10:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Replace all instances of JSDoc generic Function with detailed @callback definition (type-only changes).

Browse source
This commit is contained in:
David Anson 2023-09-04 21:41:16 -07:00
parent 8bb97dadfe
commit 07f403173c
6 changed files with 199 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

8
lib/markdownlint.d.ts vendored
View file

@ -8,7 +8,7 @@ export = markdownlint;
*/
declare function markdownlint(options: Options | null, callback: LintCallback): void;
declare namespace markdownlint {
export { markdownlintSync as sync, readConfig, readConfigSync, getVersion, promises, RuleFunction, RuleParams, MarkdownItToken, RuleOnError, RuleOnErrorInfo, RuleOnErrorFixInfo, Rule, Options, Plugin, ToStringCallback, LintResults, LintError, FixInfo, LintCallback, Configuration, RuleConfiguration, ConfigurationParser, ReadConfigCallback, ResolveConfigExtendsCallback };
export { markdownlintSync as sync, readConfig, readConfigSync, getVersion, promises, RuleFunction, RuleParams, MarkdownItToken, RuleOnError, RuleOnErrorInfo, RuleOnErrorFixInfo, Rule, Options, Plugin, ToStringCallback, LintResults, LintError, FixInfo, LintContentCallback, LintCallback, Configuration, RuleConfiguration, ConfigurationParser, ReadConfigCallback, ResolveConfigExtendsCallback };
}
/**
* Configuration options.
@ -64,7 +64,7 @@ type Options = {
/**
* Called with the result of the lint function.
*/
type LintCallback = (err: Error | null, results?: LintResults) => void;
type LintCallback = (error: Error | null, results?: LintResults) => void;
/**
* Lint specified Markdown files synchronously.
*
@ -353,6 +353,10 @@ type FixInfo = {
*/
insertText?: string;
};
/**
* Called with the result of linting a string or document.
*/
type LintContentCallback = (error: Error | null, result?: LintError[]) => void;
/**
* Configuration object for linting rules. For a detailed schema, see
* {@link ../schema/markdownlint-config-schema.json}.