mark-util-symbol

mark utility with symbols.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Types
• Project
  • Version
  • Contribute
  • Sponsor
• Related

What is this?

This package exposes constants used throughout the mark ecosystem.

When should I use this?

This package is useful when creating your own your own mark extensions and utilities.

Install

This package is ESM only.

In Node.js with yarn:

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

See Git - Protocols | Yarn  for details regarding installing from Git.

In Deno with esm.sh:

import { chars, codes } from 'https://esm.sh/@flex-development/mark-util-symbol'

In browsers with esm.sh:

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

Use

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

console.log(chars.at) // '@'
console.log(codes.at) // 64
console.log(constants.tabSize) // 2
console.log(ev.enter) // 'enter'

API

This package exports the identifiers chars, codes, constants, and ev.
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

mark-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.

Related

• @flex-development/mark — the specification
• @flex-development/mark-compiler — finite state machine event compiler
• @flex-development/mark-parser — finite state machine parser