29 lines
963 B
TypeScript
29 lines
963 B
TypeScript
|
/**
|
||
|
|
* Make a string safe for embedding in markdown constructs.
|
||
|
|
*
|
||
|
|
* In markdown, almost all punctuation characters can, in certain cases,
|
||
|
|
* result in something.
|
||
|
|
* Whether they do is highly subjective to where they happen and in what
|
||
|
|
* they happen.
|
||
|
|
*
|
||
|
|
* To solve this, `mdast-util-to-markdown` tracks:
|
||
|
|
*
|
||
|
|
* * Characters before and after something;
|
||
|
|
* * What “constructs” we are in.
|
||
|
|
*
|
||
|
|
* This information is then used by this function to escape or encode
|
||
|
|
* special characters.
|
||
|
|
*
|
||
|
|
* @param {State} state
|
||
|
|
* Info passed around about the current state.
|
||
|
|
* @param {string | null | undefined} input
|
||
|
|
* Raw value to make safe.
|
||
|
|
* @param {SafeConfig} config
|
||
|
|
* Configuration.
|
||
|
|
* @returns {string}
|
||
|
|
* Serialized markdown safe for embedding.
|
||
|
|
*/
|
||
|
|
export function safe(state: State, input: string | null | undefined, config: SafeConfig): string;
|
||
|
|
export type SafeConfig = import('../types.js').SafeConfig;
|
||
|
|
export type State = import('../types.js').State;
|