API Reference

Welcome to the ContextJS API Reference.
This section documents all public APIs, core types, and extension points for every package in the ContextJS ecosystem.

Each package is fully typed and designed for seamless integration in TypeScript projects. Use the links below to view detailed class, interface, function, and type definitions.

Packages

Package	Description	API Docs
@contextjs/collections	Generic data structures such as Dictionary, List, Queue, and Stack.	View
@contextjs/configuration	Configuration abstraction, including runtime config loading and providers.	View
@contextjs/configuration-json	JSON configuration provider that loads environment-aware settings with fallback support.	View
@contextjs/context	Main entrypoint for CLI, project scaffolding, and extension management.	View
@contextjs/di	Type-safe dependency injection, lifetimes, and service collections.	View
@contextjs/io	File, directory, and path utilities, plus robust exceptions for I/O.	View
@contextjs/routing	Route parsing, scoring, and route info structures.	View
@contextjs/system	Core utilities: exception hierarchy, console, extensions, and versioning.	View
@contextjs/text	String manipulation, formatters, and builders.	View
@contextjs/webserver	High-performance HTTP/2 server, context objects, and webserver options.	View
@contextjs/webserver-middleware-controllers	Controllers middleware for the ContextJS webserver.	View
@contextjs/webserver-middleware-cookies	Middleware for ContextJS WebServer that transparently handles HTTP cookies in requests and responses.	View
@contextjs/webserver-middleware-static	Middleware for ContextJS WebServer that serves static files.	View

---

How to Use

• All APIs are type-safe and fully documented.
• Classes and interfaces are grouped by package for quick discovery.
• See the sidebar for direct navigation.

For package installation and getting started guides, see the Guide.

---

Need more details?
You can also consult the README for each package or review source-level comments for advanced usage.