Documentation

Deepkit is an open-source TypeScript framework for backend applications freely available under the MIT license, designed to help you build scalable and maintainable backend applications. It's designed to work in the browser and Node.js, but can run in any proper JavaScript environment.

Here you find chapters for the different components of Deepkit and API references for all our packages.

If you need help, please feel free to join our Discord server or open an issue on GitHub.

Chapters

App - Write your first application with Deepkit based on the command line interface.
Framework - Add application (HTTP/RPC) server, API docs, debugger, integration tests, and more to your application.
Runtime Types - Learn about TypeScript runtime types, and to validate and transform data.
Dependency Injection - Dependency injection container, inversion of control, and dependency inversion.
Filesystem - Filesystem abstraction to work with local and remote files systems in unified way.
Broker - Message broker abstraction to work with distributed L2 cache, pub/sub, queues, central atomic locks, or key-value store.
HTTP - HTTP server abstraction to build type-safe endpoints.
RPC - Remote procedure call abstraction to connect frontend with backend, or to connect multiple backend services.
ORM - ORM and DBAL to store and query data in a type-safe way.
Desktop-UI - Build GUI applications with Deepkit's Angular-based UI framework.

API Reference

Following is a complete list of all Deepkit packages with links to their API documentation.

Documentation

Chapters

API Reference

Composition

Infrastructure

Filesystem

Database

Fundamentals

Tools

Core

Runtime