Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/navigation/model

Destination

Describes a committed history entry with stable id and key identity.

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

Import

import { Destination } from "@typed/navigation/model";

Signatures

export declare const Destination: Schema.Struct<{
    readonly id: Schema.String;
    readonly key: Schema.String;
    readonly url: Schema.URLFromString;
    readonly state: Schema.Unknown;
    readonly sameDocument: Schema.Boolean;
}>;
export type Destination = typeof Destination.Type;

Why

Routers and state stores need identity that survives URL equality: key addresses traversal, while id distinguishes commits which may otherwise contain the same URL and state.

Ownership and lifetime

This immutable schema acquires no resources. The active navigation provider owns entry creation, retention, serialization, and eviction.

Examples

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

const decode = Schema.decodeUnknownSync(Destination)

Other public imports

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

Source