interface / @typed/router/Parser

Parser.Char

Consumes one exact leading character.

Package version
1.0.0-beta.13
Category
Parser primitives
Since
1.0.0
Member of
Parser

Import

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

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

Signatures

interface Char<C extends string> extends TypeFunction<string, Result<C, string>> {
    readonly return: InputOf<this> extends `${C}${infer Rest}` ? readonly [
        C,
        Rest
    ] : never;
}

Why

Atomic character matching builds route punctuation parsers without widening input.

Ownership and lifetime

TypeScript instantiates Char 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 Char.return when the surrounding parser is applied; the associated result is erased and retains no input at runtime.

Source