38 lines
1.1 KiB
TypeScript
38 lines
1.1 KiB
TypeScript
|
/**
|
||
|
|
* Create a duplex (readable and writable) stream.
|
||
|
|
*
|
||
|
|
* Some of the work to parse markdown can be done streaming, but in the
|
||
|
|
* end buffering is required.
|
||
|
|
*
|
||
|
|
* micromark does not handle errors for you, so you must handle errors on whatever
|
||
|
|
* streams you pipe into it.
|
||
|
|
* As markdown does not know errors, `micromark` itself does not emit errors.
|
||
|
|
*
|
||
|
|
* @param {Options | null | undefined} [options]
|
||
|
|
* Configuration (optional).
|
||
|
|
* @returns {MinimalDuplex}
|
||
|
|
* Duplex stream.
|
||
|
|
*/
|
||
|
|
export function stream(options?: Options | null | undefined): MinimalDuplex
|
||
|
|
export type Options = import('micromark-util-types').Options
|
||
|
|
export type Value = import('micromark-util-types').Value
|
||
|
|
export type Encoding = import('micromark-util-types').Encoding
|
||
|
|
/**
|
||
|
|
* Function called when write was successful.
|
||
|
|
*/
|
||
|
|
export type Callback = () => undefined
|
||
|
|
export type PipeOptions = {
|
||
|
|
end?: boolean | null | undefined
|
||
|
|
}
|
||
|
|
export type MinimalDuplex = Omit<
|
||
|
|
NodeJS.ReadableStream & NodeJS.WritableStream,
|
||
|
|
| 'isPaused'
|
||
|
|
| 'pause'
|
||
|
|
| 'read'
|
||
|
|
| 'resume'
|
||
|
|
| 'setEncoding'
|
||
|
|
| 'unpipe'
|
||
|
|
| 'unshift'
|
||
|
|
| 'wrap'
|
||
|
|
>
|