site/node_modules/micromark-factory-whitespace/dev/index.d.ts
2024-10-14 08:09:33 +02:00

22 lines
714 B
TypeScript

/**
* Parse spaces and tabs.
*
* There is no `nok` parameter:
*
* * line endings or spaces in markdown are often optional, in which case this
* factory can be used and `ok` will be switched to whether spaces were found
* or not
* * one line ending or space can be detected with
* `markdownLineEndingOrSpace(code)` right before using `factoryWhitespace`
*
* @param {Effects} effects
* Context.
* @param {State} ok
* State switched to when successful.
* @returns {State}
* Start state.
*/
export function factoryWhitespace(effects: Effects, ok: State): State
export type Effects = import('micromark-util-types').Effects
export type State = import('micromark-util-types').State