32 lines
833 B
TypeScript
32 lines
833 B
TypeScript
/**
|
||
* Get the text content of a node or list of nodes.
|
||
*
|
||
* Prefers the node’s plain-text fields, otherwise serializes its children,
|
||
* and if the given value is an array, serialize the nodes in it.
|
||
*
|
||
* @param {unknown} [value]
|
||
* Thing to serialize, typically `Node`.
|
||
* @param {Options | null | undefined} [options]
|
||
* Configuration (optional).
|
||
* @returns {string}
|
||
* Serialized `value`.
|
||
*/
|
||
export function toString(
|
||
value?: unknown,
|
||
options?: Options | null | undefined
|
||
): string
|
||
export type Nodes = import('mdast').Nodes
|
||
/**
|
||
* Configuration (optional).
|
||
*/
|
||
export type Options = {
|
||
/**
|
||
* Whether to use `alt` for `image`s (default: `true`).
|
||
*/
|
||
includeImageAlt?: boolean | null | undefined
|
||
/**
|
||
* Whether to use `value` of HTML (default: `true`).
|
||
*/
|
||
includeHtml?: boolean | null | undefined
|
||
}
|