docmark-util-symbol

docmark utility with symbols.

Contents

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

What is this?

This package exposes constants used throughout the docmark ecosystem.

When should I use this?

This package is useful when making your docmark extensions. It’s useful to reference these constants by name instead of value while developing.

Install

This package is ESM only.

In Node.js with yarn:

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

In Deno with esm.sh:

import { chars, codes, constants, ct, ev, tt } from 'https://esm.sh/@flex-development/docmark-util-symbol'

In browsers with esm.sh:

<script type="module">
  import { chars, codes, constants, ct, ev, tt } from 'https://esm.sh/@flex-development/docmark-util-symbol'
</script>

Use

import { chars, codes, constants, ct, ev, tt } from '@flex-development/docmark-util-symbol'

console.log(chars.at) // '@'
console.log(codes.at) // 64
console.log(constants.tabSize) // 4
console.log(ct.comment) // 'comment'
console.log(ev.enter) // 'enter'
console.log(tt.tagName) // 'tagName'

API

This package exports the identifiers chars, codes, constants, ct, ev, and tt.
There is no default export.

Each identifier is an object mapping strings to values.
See the code for the exposed data.

Types

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

Project

Version

docmark-util-symbol 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

Small primitives power larger systems. Support long-term stability by sponsoring Flex Development.