mirror of
https://github.com/Funkoala14/knowledgebase_law.git
synced 2025-06-08 20:48:15 +08:00
82 lines
2.8 KiB
TypeScript
82 lines
2.8 KiB
TypeScript
|
/**
|
|||
|
|
* Compile markdown to HTML.
|
|||
|
|
*
|
|||
|
|
* > Note: which encodings are supported depends on the engine.
|
|||
|
|
* > For info on Node.js, see:
|
|||
|
|
* > <https://nodejs.org/api/util.html#whatwg-supported-encodings>.
|
|||
|
|
*
|
|||
|
|
* @overload
|
|||
|
|
* @param {Value} value
|
|||
|
|
* Markdown to parse (`string` or `Uint8Array`).
|
|||
|
|
* @param {Encoding | null | undefined} encoding
|
|||
|
|
* Character encoding to understand `value` as when it’s a `Uint8Array`
|
|||
|
|
* (`string`, default: `'utf8'`).
|
|||
|
|
* @param {Options | null | undefined} [options]
|
|||
|
|
* Configuration.
|
|||
|
|
* @returns {string}
|
|||
|
|
* Compiled HTML.
|
|||
|
|
*
|
|||
|
|
* @overload
|
|||
|
|
* @param {Value} value
|
|||
|
|
* Markdown to parse (`string` or `Uint8Array`).
|
|||
|
|
* @param {Options | null | undefined} [options]
|
|||
|
|
* Configuration.
|
|||
|
|
* @returns {string}
|
|||
|
|
* Compiled HTML.
|
|||
|
|
*
|
|||
|
|
* @param {Value} value
|
|||
|
|
* Markdown to parse (`string` or `Uint8Array`).
|
|||
|
|
* @param {Encoding | Options | null | undefined} [encoding]
|
|||
|
|
* Character encoding to understand `value` as when it’s a `Uint8Array`
|
|||
|
|
* (`string`, default: `'utf8'`).
|
|||
|
|
* @param {Options | null | undefined} [options]
|
|||
|
|
* Configuration.
|
|||
|
|
* @returns {string}
|
|||
|
|
* Compiled HTML.
|
|||
|
|
*/
|
|||
|
|
export function micromark(value: Value, encoding: Encoding | null | undefined, options?: Options | null | undefined): string;
|
|||
|
|
/**
|
|||
|
|
* Compile markdown to HTML.
|
|||
|
|
*
|
|||
|
|
* > Note: which encodings are supported depends on the engine.
|
|||
|
|
* > For info on Node.js, see:
|
|||
|
|
* > <https://nodejs.org/api/util.html#whatwg-supported-encodings>.
|
|||
|
|
*
|
|||
|
|
* @overload
|
|||
|
|
* @param {Value} value
|
|||
|
|
* Markdown to parse (`string` or `Uint8Array`).
|
|||
|
|
* @param {Encoding | null | undefined} encoding
|
|||
|
|
* Character encoding to understand `value` as when it’s a `Uint8Array`
|
|||
|
|
* (`string`, default: `'utf8'`).
|
|||
|
|
* @param {Options | null | undefined} [options]
|
|||
|
|
* Configuration.
|
|||
|
|
* @returns {string}
|
|||
|
|
* Compiled HTML.
|
|||
|
|
*
|
|||
|
|
* @overload
|
|||
|
|
* @param {Value} value
|
|||
|
|
* Markdown to parse (`string` or `Uint8Array`).
|
|||
|
|
* @param {Options | null | undefined} [options]
|
|||
|
|
* Configuration.
|
|||
|
|
* @returns {string}
|
|||
|
|
* Compiled HTML.
|
|||
|
|
*
|
|||
|
|
* @param {Value} value
|
|||
|
|
* Markdown to parse (`string` or `Uint8Array`).
|
|||
|
|
* @param {Encoding | Options | null | undefined} [encoding]
|
|||
|
|
* Character encoding to understand `value` as when it’s a `Uint8Array`
|
|||
|
|
* (`string`, default: `'utf8'`).
|
|||
|
|
* @param {Options | null | undefined} [options]
|
|||
|
|
* Configuration.
|
|||
|
|
* @returns {string}
|
|||
|
|
* Compiled HTML.
|
|||
|
|
*/
|
|||
|
|
export function micromark(value: Value, options?: Options | null | undefined): string;
|
|||
|
|
export { compile } from "./lib/compile.js";
|
|||
|
|
export { parse } from "./lib/parse.js";
|
|||
|
|
export { postprocess } from "./lib/postprocess.js";
|
|||
|
|
export { preprocess } from "./lib/preprocess.js";
|
|||
|
|
export type Options = import("micromark-util-types").Options;
|
|||
|
|
import type { Value } from 'micromark-util-types';
|
|||
|
|
import type { Encoding } from 'micromark-util-types';
|
|||
|
|
//# sourceMappingURL=index.d.ts.map
|