4.5 KiB
micromark-util-symbol
micromark utility with symbols.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package exposes constants used throughout the micromark ecosystem.
When should I use this?
This package is useful when you are making your own micromark extensions.
It’s useful to reference these constants by name instead of value while
developing.
micromark-build compiles them away for production code.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install micromark-util-symbol
In Deno with esm.sh:
import * as symbol from 'https://esm.sh/micromark-util-symbol@1'
In browsers with esm.sh:
<script type="module">
import * as symbol from 'https://esm.sh/micromark-util-symbol@1?bundle'
</script>
Use
import {codes, constants, types, values} from 'micromark-util-symbol'
console.log(codes.atSign) // 64
console.log(constants.characterReferenceNamedSizeMax) // 31
console.log(types.definitionDestinationRaw) // 'definitionDestinationRaw'
console.log(values.atSign) // '@'
API
This package exports the identifiers codes, constants, types, and
values.
There is no default export.
Each identifier is an object mapping strings to values. See the code for the exposed data.
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-symbol@^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.