.. | ||
dev | ||
index.d.ts | ||
index.js | ||
package.json | ||
readme.md |
micromark-util-normalize-identifier
micromark utility normalize identifiers.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package exposes an algorithm to normalize identifiers found in markdown.
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-normalize-identifier
In Deno with esm.sh
:
import {normalizeIdentifier} from 'https://esm.sh/micromark-util-normalize-identifier@1'
In browsers with esm.sh
:
<script type="module">
import {normalizeIdentifier} from 'https://esm.sh/micromark-util-normalize-identifier@1?bundle'
</script>
Use
import {normalizeIdentifier} from 'micromark-util-normalize-identifier'
normalizeIdentifier(' a ') // 'A'
normalizeIdentifier('a\t\r\nb') // 'A B'
normalizeIdentifier('ТОЛПОЙ') // 'ТОЛПОЙ'
normalizeIdentifier('Толпой') // 'ТОЛПОЙ'
API
This module exports the identifier
normalizeIdentifier
.
There is no default export.
normalizeIdentifier(value)
Normalize an identifier (as found in references, definitions).
Collapses markdown whitespace, trim, and then lower- and uppercase.
Some characters are considered “uppercase”, such as U+03F4 (ϴ
), but if their
lowercase counterpart (U+03B8 (θ
)) is uppercased will result in a different
uppercase character (U+0398 (Θ
)).
So, to get a canonical form, we perform both lower- and uppercase.
Using uppercase last makes sure keys will never interact with default
prototypal values (such as constructor
): nothing in the prototype of Object
is uppercase.
Parameters
value
(string
) — identifier to normalize
Returns
Normalized identifier (string
).
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-normalize-identifier@^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.