@ucdjs/docs

Packages

Explore the UCD.js package ecosystem.

UCD.js is organized as a monorepo with multiple packages, each serving a specific purpose in working with Unicode Character Database.

Core Packages

UCD Store

Store for managing Unicode Character Database files. Supports multiple file system bridges (Node.js, HTTP, in-memory).

CLI

Command-line interface for UCD operations with the ucd binary.

Client

OpenAPI-based API client for the UCD API at api.ucdjs.dev.

FS Bridge

File system abstraction layer that allows different storage backends.

Schemas & Generation

Schemas

Zod schemas for Unicode data files with full type safety.

Schema Gen

Uses AI (OpenAI) to generate TypeScript schemas from Unicode data files.

Utilities

Utilities

Shared utilities, path manipulation, and environment configuration packages.

Package Compatibility

All packages are:

  • Built with TypeScript for full type safety
  • Distributed as ES modules
  • Compatible with Node.js >= 22.18
  • Tree-shakable for optimal bundle sizes

Installation

Install individual packages as needed:

npm
npm install @ucdjs/ucd-store
pnpm
pnpm add @ucdjs/ucd-store
yarn
yarn add @ucdjs/ucd-store

Installation

Get started with UCD.js.

Utilities

Shared utilities and helper packages.