4.5 KiB
micromark-util-subtokenize
micromark utility to tokenize subtokens.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package exposes a micromark internal that you probably don’t need.
When should I use this?
This package might be useful when you are making your own micromark extensions.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install micromark-util-subtokenize
In Deno with esm.sh:
import {subtokenize} from 'https://esm.sh/micromark-util-subtokenize@1'
In browsers with esm.sh:
<script type="module">
import {subtokenize} from 'https://esm.sh/micromark-util-subtokenize@1?bundle'
</script>
Use
import {subtokenize} from 'micromark-util-subtokenize'
/**
* Content is transparent: it’s parsed right now. That way, definitions are also
* parsed right now: before text in paragraphs (specifically, media) are parsed.
*
* @type {Resolver}
*/
function resolveContent(events) {
subtokenize(events)
return events
}
API
This module exports the identifiers subtokenize.
There is no default export.
subtokenize(events)
Tokenize subcontent.
Parameters
events(Array<Event>) — list of events
Returns
Whether subtokens were found (boolean).
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-util-subtokenize@^2, compatible with Node.js 16.
This package works with micromark@^3.
Security
This package is safe.
See security.md in micromark/.github for how to
submit a security report.
Contribute
See contributing.md in micromark/.github for ways
to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.