Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

micromark-factory-destination

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

micromark-factory-destination

micromark factory to parse destinations (found in resources, definitions)

  • 2.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6.8M
increased by1.92%
Maintainers
1
Weekly downloads
 
Created
Source

micromark-factory-destination

Build Coverage Downloads Size Sponsors Backers Chat

micromark factory to parse destinations (found in resources, definitions).

Contents

What is this?

This package exposes states to parse destinations.

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-destination

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {factoryDestination} from 'micromark-factory-destination'
import {codes, types} from 'micromark-util-symbol'

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

  // …

  /** @type {State} */
  function open(code) {
    if (code === codes.rightParenthesis) {
      return end(code)
    }

    return factoryDestination(
      effects,
      destinationAfter,
      nok,
      types.resourceDestination,
      types.resourceDestinationLiteral,
      types.resourceDestinationLiteralMarker,
      types.resourceDestinationRaw,
      types.resourceDestinationString,
      constants.linkResourceDestinationBalanceMax
    )(code)
  }

  // …
}

API

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

factoryDestination(…)

Parse destinations.

Examples
<a>
<a\>b>
<a b>
<a)>
a
a\)b
a(b)c
a(b)
Parameters
  • effects (Effects) — context
  • ok (State) — state switched to when successful
  • nok (State) — state switched to when unsuccessful
  • type (string) — type for whole (<a> or b)
  • literalType (string) — type when enclosed (<a>)
  • literalMarkerType (string) — type for enclosing (< and >)
  • rawType (string) — type when not enclosed (b)
  • stringType (string) — type for the value (a or b)
  • max (number, default: Infinity) — depth of nested parens (inclusive)
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-destination@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

Keywords

FAQs

Package last updated on 12 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc