micromark-factory-whitespace
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizebundle-size-badgebundle-size
!Sponsorssponsors-badgeopencollective
!Backersbackers-badgeopencollective
!Chatchat-badgechatmicromark factory to parse markdown line endings or spacesws (found in lots of places).
Contents
* [`factoryWhitespace(…)`](#factorywhitespace)
What is this?
This package exposes states to parse whitespace.When should I use this?
This package is useful when you are making your own micromark extensions.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install micromark-factory-whitespace
In Deno with
esm.sh
esmsh:import {factoryWhitespace} from 'https://esm.sh/micromark-factory-whitespace@1'
In browsers with
esm.sh
esmsh:<script type="module">
import {factoryWhitespace} from 'https://esm.sh/micromark-factory-whitespace@1?bundle'
</script>
Use
import {factoryWhitespace} from 'micromark-factory-whitespace'
import {codes, types} from 'micromark-util-symbol'
// A micromark tokenizer that uses the factory:
/**
* @this {TokenizeContext}
* @type {Tokenizer}
*/
function tokenizeTitle(effects, ok, nok) {
return start
/** @type {State} */
function start(code) {
return markdownLineEndingOrSpace(code)
? factoryWhitespace(effects, before)(code)
: nok(code)
}
// …
}
API
This module exports the identifierfactoryWhitespace
api-factory-whitespace.
There is no default export.factoryWhitespace(…)
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)`][ws] right before using
`factoryWhitespace`
Parameters
effects
(Effects
)
— context
ok
(State
)
— state switched to when successful
Returns
Start state (State
).Types
This package is fully typed with TypeScript. It exports no additional types.Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
micromark-factory-whitespace@^2
, compatible with Node.js 16.
This package works with micromark@^3
.Security
This package is safe. Seesecurity.md
securitymd in micromark/.github
health for how to
submit a security report.Contribute
Seecontributing.md
contributing in micromark/.github
health for ways
to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.