micromark-util-resolve-all
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    micromark-util-resolve-all

    Build Coverage Downloads Size Sponsors Backers Chat

    micromark utility to resolve subtokens.

    Resolvers are functions that take events and manipulate them. This is needed for example because media (links, images) and attention (strong, italic) aren’t parsed left-to-right. Instead, their openings and closings are parsed, and when done, their openings and closings are matched, and left overs are turned into plain text. Because media and attention can’t overlap, we need to perform that operation when one closing matches an opening, too.

    Contents

    Install

    npm:

    npm install micromark-util-resolve-all

    Use

    import {push} from 'micromark-util-chunked'
    import {resolveAll} from 'micromark-util-resolve-all'
    
    /**
     * @type {Resolver}
     */
    function resolveAllAttention(events, context) {
      // …
    
      // Walk through all events.
      while (++index < events.length) {
        // Find a token that can close.
        if (
          events[index][0] === 'enter' &&
          events[index][1].type === 'attentionSequence' &&
          events[index][1]._close
        ) {
          open = index
    
          // Now walk back to find an opener.
          while (open--) {
            // Find a token that can open the closer.
            if (
              // …
            ) {
              // …
    
              // Opening.
              nextEvents = push(nextEvents, [
                // …
              ])
    
              // Between.
              nextEvents = push(
                nextEvents,
                resolveAll(
                  context.parser.constructs.insideSpan.null,
                  events.slice(open + 1, index),
                  context
                )
              )
    
              // Closing.
              nextEvents = push(nextEvents, [
                // …
              ])
    
              // …
            }
          }
        }
      }
    
      // …
    }

    API

    This module exports the following identifiers: resolveAll. There is no default export.

    resolveAll(constructs, events, context)

    Call all resolveAlls in constructs.

    Parameters
    • constructs (Construct[]) — List of constructs, optionally with resolveAlls
    • events (Event[]) — List of events
    • context (TokenizeContext) — Context used by tokenize
    Returns

    Events[] — Changed events.

    Security

    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

    Install

    npm i micromark-util-resolve-all

    DownloadsWeekly Downloads

    2,858

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    7.44 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar