@valkyrjaio/valkyrja
v26.1.0
Published
The Valkyrja Framework.
Downloads
436
Readme
Valkyrja
Valkyrja is a TypeScript framework for web and console applications.
Valkyrja (pronounced "Valk-ear-ya") is the Old Norse spelling for Valkyrie, a mythical creature that would guide warriors to Valhalla (the afterlife and a better place) after death. In a similar sense, the Valkyrja framework guides your application to be in a better state. Fast, light, and robust, Valkyrja does the heavy lifting so you can focus on your application.
What's Included
- HTTP and CLI kernels — unified application architecture serving both web requests and command-line invocations
- Dependency injection container — deferred bindings, contextual resolution, and child containers for fast resolution at runtime
- Routing — expressive HTTP and CLI route definitions with middleware, constraints, and reverse URL resolution
- HTTP messages — PSR-style requests, responses, streams, URIs, uploaded files, and headers
- Event dispatcher — decoupled event handling with typed listeners
- Validation — rule-based validation for input data
Installation
Start a New Application
The fastest way to start a new Valkyrja application is with the starter app or the Sindri build tool:
- Use the
valkyrja-starter-app-tsGitHub template ("Use this template" button on the repository page) - Or use Sindri to scaffold and build your project
Add to an Existing Project
To install the framework as a dependency:
npm install @valkyrjaio/valkyrjaImport only what you need, by path:
import { Application } from '@valkyrjaio/valkyrja/Application/Kernel/Application.js';Documentation
Full documentation is available on the Valkyrja website.
Ecosystem
Valkyrja is the core framework. Surrounding it is an ecosystem of related projects in the Valkyrjaio organization:
- Sindri — build tool and application creator
- Starter (App) — starter application for new projects
See the Valkyrjaio organization page for the complete listing.
Versioning and Release Process
Valkyrja follows semantic versioning with a major release every year, and support for each major version for 2 years from the date of release.
For more information see our Versioning and Release Process documentation.
Supported Versions
Bug fixes are provided until 3 months after the next major release. Security fixes are provided for 2 years after the initial release.
| Version | Node | Release | Bug Fixes Until | Security Fixes Until | | :------ | :--- | :------------- | :-------------- | :------------------- | | 26 | 22+ | March 31, 2026 | Q2 2027 | Q1 2028 |
Contributing
Valkyrja is an open-source, community-driven project. Thank you for your interest in helping develop, maintain, and release it.
See CONTRIBUTING.md for the submission process and
VOCABULARY.md for the terminology used across Valkyrja.
Security Issues
If you discover a security vulnerability within Valkyrja, please follow our disclosure procedure.
License
Valkyrja is open-source software licensed under the
MIT license. See LICENSE.md.
