Cesium Utils - v0.0.20

Cesium Utils

A utility library for Cesium.js that simplifies working with collections and terrain providers.

📚 API Documentation | 📦 NPM Package | ▶️ Demonstration

Installation

# npm
npm install @juun-roh/cesium-utils

# yarn
yarn add @juun-roh/cesium-utils

# pnpm
pnpm add @juun-roh/cesium-utils

Browser Compatibility

This library works in both modern browsers and Node.js environments. It supports:

ESM (ECMAScript modules)
CommonJS (via a bundled .cjs file)

Modular Exports

This library supports modular exports, which enables for you to import only needed modules. Though this library is about 140kB, you can minimize the size for importing this library.

// This imports all modules of the package
import { Collection } from "@juun-roh/cesium-utils";
// To minimize the imported modules size, try this:
import { Highlight } from "@juun-roh/cesium-utils/highlight";

Development

Building

# Install dependencies
pnpm install

# Build
pnpm build

# Run tests
pnpm test

Demonstration

Working on the demonstration at Cesium Utils Demo.

Documentation

Generate API documentation:

pnpm typedoc