Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/navigation

NavigationType

Validates the four transition operations understood by navigation providers.

Package version
1.0.0-beta.13
Category
Transition schemas
Since
1.0.0

Import

import { NavigationType } from "@typed/navigation";

Signatures

export declare const NavigationType: Schema.Union<readonly [
    Schema.Literal<"push">,
    Schema.Literal<"replace">,
    Schema.Literal<"reload">,
    Schema.Literal<"traverse">
]>;
export type NavigationType = typeof NavigationType.Type;

Why

A closed operation vocabulary lets handlers distinguish history growth, replacement, reload, and traversal without inspecting backend-specific events.

Ownership and lifetime

This immutable schema acquires no resources.

Examples

import { NavigationType } from "@typed/navigation/model"
import * as Schema from "effect/Schema"

Schema.decodeUnknownSync(NavigationType)("replace")

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source