vorma

package module
v0.85.0-pre.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2026 License: BSD-3-Clause Imports: 5 Imported by: 0

README

Vorma Framework

Vorma banner

Vorma seeks to be the world's most straightforward web framework.

vorma.dev | github.com | pkg.go.dev | npmx.dev | x.com

Quick Start

npm create vorma@latest

Status

Expect frequent breaking changes while we are still sub-v1.0.0.

Documentation

Index

Constants

View Source
const (
	ClientBuildIDHeaderKey       = vormarun.X_Vorma_Client_Build_Id
	PublicStaticOutNamePrefix    = vormarun.Public_Static_Out_Name_Prefix
	PublicStaticPrehashedDirname = vormarun.Prehashed_Dirname
)

Variables

This section is empty.

Functions

func InitRouter

func InitRouter(
	v *Vorma,
	loaders []AnyLoader,
	actions []AnyAction,
	staticFS fs.FS,
) (*mux.Router, error)

func IsDev

func IsDev() bool

func MakeRootFunc

func MakeRootFunc(cwdBase string) func(subPath string) string

Types

type Action

type Action[
	I any,
	O any,
	CtxPtr ~*Ctx,
	Ctx vormarun.ActionCtxWrapper[I, CtxPtr],
] = vormarun.Action[I, O, CtxPtr, Ctx]

type ActionCtx

type ActionCtx[I any] = vormarun.ActionCtx[I]

type Actions

type Actions = []AnyAction

type AnyAction

type AnyAction = vormarun.AnyAction

type AnyLoader

type AnyLoader = vormarun.AnyLoader

type DevWatchConfig

type DevWatchConfig = vormarun.DevWatchConfig

type FormData

type FormData = vormarun.FormData

type FrontendConfig

type FrontendConfig = vormarun.FrontendConfig

type GoTypeSrc

type GoTypeSrc = vormarun.GoTypeSrc

func GoType

func GoType[T any](requestedName ...string) *GoTypeSrc

type HTMLConfig

type HTMLConfig = vormarun.HTMLConfig

type HeadEls

type HeadEls = vormarun.HeadEls

type Loader

type Loader[
	O any,
	CtxPtr ~*Ctx,
	Ctx vormarun.LoaderCtxWrapper[CtxPtr],
] = vormarun.Loader[O, CtxPtr, Ctx]

type LoaderCtx

type LoaderCtx = vormarun.LoaderCtx

type LoaderError

type LoaderError = vormarun.LoaderError

type Loaders

type Loaders = []AnyLoader

type PathConfig

type PathConfig = vormarun.PathConfig

type TSDrafter

type TSDrafter = vormarun.TSDrafter

type TSGenConfig

type TSGenConfig = vormarun.TSGenConfig

type Vorma

type Vorma = vormarun.Vorma

Directories

Path Synopsis
This package is not meant to be called directly by users.
This package is not meant to be called directly by users.
internal
cmd/bumper command
cmd/npm_bumper command
cmd/sum command
pkg/lockfile
Package lockfile provides cross-process file locks using lease heartbeats and stale-lock reclamation semantics for command and daemon orchestration.
Package lockfile provides cross-process file locks using lease heartbeats and stale-lock reclamation semantics for command and daemon orchestration.
kit
bytesutil
Package bytesutil provides utility functions for byte slice operations.
Package bytesutil provides utility functions for byte slice operations.
cookies
Package cookies provides secure cookie helpers and policy-driven defaults.
Package cookies provides secure cookie helpers and policy-driven defaults.
cryptoutil
Package cryptoutil provides utility functions for cryptographic operations.
Package cryptoutil provides utility functions for cryptographic operations.
csrf
Package csrf provides a robust, stateless, and layered CSRF protection middleware for Go.
Package csrf provides a robust, stateless, and layered CSRF protection middleware for Go.
fsutil
Package fsutil provides utility functions for working with the filesystem.
Package fsutil provides utility functions for working with the filesystem.
genericsutil
Package genericsutil provides helpers for implementing type erasure patterns
Package genericsutil provides helpers for implementing type erasure patterns
htmlutil
Package htmlutil provides safe HTML element construction and rendering.
Package htmlutil provides safe HTML element construction and rendering.
id
k9
Package k9 generates 16-byte k-sortable IDs, with human-friendly string encoding.
Package k9 generates 16-byte k-sortable IDs, with human-friendly string encoding.
lru
Package lru implements a generic Least Recently Used (LRU) cache with support for "spam" items and TTL (Time-To-Live).
Package lru implements a generic Least Recently Used (LRU) cache with support for "spam" items and TTL (Time-To-Live).
matcher
Package matcher provides route pattern matching with support for static, dynamic, and splat segments.
Package matcher provides route pattern matching with support for static, dynamic, and splat segments.
mux
Package mux provides typed HTTP routing with pattern matching, middleware composition, and nested route execution.
Package mux provides typed HTTP routing with pattern matching, middleware composition, and nested route execution.
response
Package response provides thin, explicit HTTP response helpers.
Package response provides thin, explicit HTTP response helpers.
securebytes
This package assumes that the caller's use case is not sensitive to timing attacks.
This package assumes that the caller's use case is not sensitive to timing attacks.
securestring
This package assumes that the caller's use case is not sensitive to timing attacks.
This package assumes that the caller's use case is not sensitive to timing attacks.
set
tasks
Package tasks provides memoized, concurrency-safe task execution.
Package tasks provides memoized, concurrency-safe task execution.
validate
Package validate provides validation and parsing for HTTP request data.
Package validate provides validation and parsing for HTTP request data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL