micromark-util-types

micromark-util-types

micromark utility package with TypeScript types.

Contents

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

What is this?

This package exposes TypeScript types shared throughout the micromark ecosystem.

When should I use this?

This package is useful when you are making your own, typed, micromark extensions.

Install

In Node.js (version 16+), install with npm:

npm install micromark-util-types

In Deno with esm.sh:

import type {Point, /* … */} from 'https://esm.sh/micromark-util-types@1'

Use

/**
 * @typedef {import('micromark-util-types').Point} Point
 */

API

This module exports no identifiers. There is no default export.

See the code for all about the exposed types.

Types

This package is just TypeScript types. It exports lots of different types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 16+. Our projects sometimes work with older versions, but this is not guaranteed.

This package work with micromark version 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