ideographic-description-characters

Unicode ideographic description characters as typed JSON data.

The package maps concise camelCase identifiers to the corresponding IDS operator character. It includes the 16 characters in the Ideographic Description Characters block (U+2FF0..U+2FFF) plus the two related operators that are valid in IDS syntax:

• U+303E IDEOGRAPHIC VARIATION INDICATOR
• U+31EF IDEOGRAPHIC DESCRIPTION CHARACTER SUBTRACTION

Installation

npm install ideographic-description-characters

pnpm add ideographic-description-characters

bun add ideographic-description-characters

Usage

import ideographicDescriptionCharacters from "ideographic-description-characters";

console.log(ideographicDescriptionCharacters.leftToRight);
// "⿰"

You can also import the JSON file directly:

import ideographicDescriptionCharacters from "ideographic-description-characters/characters.json" with { type: "json" };

Exports

• ideographic-description-characters Default export: ideographicDescriptionCharacters
• ideographic-description-characters/characters.json Default export: the same typed JSON object

Data

{
  "leftToRight": "⿰",
  "aboveToBelow": "⿱",
  "leftToMiddleAndRight": "⿲",
  "aboveToMiddleAndBelow": "⿳",
  "fullSurround": "⿴",
  "surroundFromAbove": "⿵",
  "surroundFromBelow": "⿶",
  "surroundFromLeft": "⿷",
  "surroundFromUpperLeft": "⿸",
  "surroundFromUpperRight": "⿹",
  "surroundFromLowerLeft": "⿺",
  "overlaid": "⿻",
  "surroundFromRight": "⿼",
  "surroundFromLowerRight": "⿽",
  "horizontalReflection": "⿾",
  "rotation": "⿿",
  "variationIndicator": "〾",
  "subtraction": "㇯"
}

Development

• Install dependencies:

bun install

• Run the unit tests:

bun test

• Run type, lint, and format checks:

bun run check

License

MIT