mark-util-combine-extensions

mark utility to combine extensions.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • combineExtensions<T>(extensions)
• Types
• Contribute

What is this?

This package exposes a utility to merge multiple syntax extensions into one.

When should I use this?

This package is useful when building mark extensions.

Install

This package is ESM only.

In Node.js with yarn:

yarn add @flex-development/mark-util-combine-extensions

In Deno with esm.sh:

import { combineExtensions } from 'https://esm.sh/@flex-development/mark-util-combine-extensions'

In browsers with esm.sh:

<script type="module">
  import { combineExtensions } from 'https://esm.sh/@flex-development/mark-util-combine-extensions'
</script>

Use

TODO: use

API

This package exports the identifier combineExtensions.
The default export is combineExtensions.

combineExtensions<T>(extensions)

Combine multiple extensions into one.

Overloads

function combineExtensions<T extends NormalizedExtension>(
  extensions: Extension | Extension[] | null | undefined
): T

function combineExtensions<T extends NormalizedExtension>(
  ...extensions: (Extension | Extension[] | null | undefined)[]
): T

Type Parameters

• T (NormalizedExtension) — the combined extension

Parameters

• extensions (Extension | Extension[] | null | undefined) — the extension to copy or the list of extensions to combine
• ...extensions ((Extension | Extension[] | null | undefined)[]) — the extensions to combine

Returns

(T) The combined extension

Types

This package is fully typed with TypeScript.
It exports no additional types.

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.