Parser.Succeed

Import

import { Parser } from "@typed/router/Parser";

Access Parser.Succeed through the imported Parser export. Its declaration below describes the member.

Signatures

interface Succeed<A> extends TypeFunction<string, Result<A, string>> {
    readonly return: InputOf<this> extends infer Input extends string ? readonly [
        A,
        Input
    ] : never;
}

Why

It supplies values to larger parser compositions while retaining the original suffix.

Ownership and lifetime

TypeScript instantiates Succeed while parsing a string-literal input; partial results and unconsumed text exist only in the resulting type.

Property: return

Computes this type lambda’s parse result for its current input.

Property: return: Why

The local type-function protocol evaluates each parser combinator through this member without a parallel runtime object.

Property: return: Ownership and lifetime

TypeScript evaluates Succeed.return when the surrounding parser is applied; the associated result is erased and retains no input at runtime.

Source

• packages/router/src/Parser.ts:108
• packages/router/src/Parser.ts:122