docmark-util-types

docmark utility package with TypeScript types.

Contents

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

What is this?

This package exposes TypeScript types shared throughout the docmark ecosystem.

When should I use this?

This package is useful when making your own, typed, docmark extensions.

Install

This package is ESM only.

In Node.js with yarn:

yarn add @flex-development/docmark-util-types

In Deno with esm.sh:

import type { Construct, /* … */ } from 'https://esm.sh/@flex-development/docmark-util-types'

Use

import type { Construct } from '@flex-development/docmark-util-types'

/**
 * @import {Construct} from '@flex-development/docmark-util-types'
 */

API

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

See the code for all exposed types.

Types

This package is fully typed with TypeScript.
It exports interfaces and types. For runtime values, see docmark-util-symbol.

Project

Version

docmark-util-types adheres to semver.

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Sponsor

Support long-term stability by sponsoring Flex Development!