site/node_modules/micromark-factory-label

micromark-factory-label

micromark factory to parse labels (found in media, definitions).

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • factoryLabel(…)
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package exposes states to parse labels.

When should I use this?

This package is 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-factory-label

In Deno with esm.sh:

import {factoryLabel} from 'https://esm.sh/micromark-factory-label@1'

In browsers with esm.sh:

<script type="module">
  import {factoryLabel} from 'https://esm.sh/micromark-factory-label@1?bundle'
</script>

Use

import {ok as assert} from 'devlop'
import {factoryLabel} from 'micromark-factory-label'
import {codes, types} from 'micromark-util-symbol'

// A micromark tokenizer that uses the factory:
/**
 * @this {TokenizeContext}
 * @type {Tokenizer}
 */
function tokenizeDefinition(effects, ok, nok) {
  return start

  // …

  /** @type {State} */
  function start(code) {
    assert(code === codes.leftSquareBracket, 'expected `[`')
    effects.enter(types.definition)
    return factoryLabel.call(
      self,
      effects,
      labelAfter,
      nok,
      types.definitionLabel,
      types.definitionLabelMarker,
      types.definitionLabelString
    )(code)
  }

  // …
}

API

This module exports the identifier factoryLabel. There is no default export.

factoryLabel(…)

Parse labels.

👉 Note: labels in markdown are capped at 999 characters in the string.

Examples

[a]
[a
b]
[a\]b]

Parameters

• this (TokenizeContext) — tokenize context
• effects (Effects) — context
• ok (State) — state switched to when successful
• nok (State) — state switched to when unsuccessful
• type (string) — type of the whole label ([a])
• markerType (string) — type for the markers ([ and ])
• stringType (string) — type for the identifier (a)

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-label@^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.

License

MIT © Titus Wormer