function / @typed/router/Path

getSchemaFields

Collects route schema fields from ordered Path AST nodes.

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

Import

import { getSchemaFields } from "@typed/router/Path";

Signatures

export declare function getSchemaFields<const Parts extends ReadonlyArray<PathAst>>(parts: Parts): {
    requiredFields: [
        string,
        Schema.Top
    ][];
    optionalFields: [
        Schema.Record.Key,
        Schema.Top
    ][];
    queryParams: [
        string,
        {
            readonly requiredFields: Array<[
                string,
                Schema.Top
            ]>;
            readonly optionalFields: Array<[
                Schema.Record.Key,
                Schema.Top
            ]>;
        }
    ][];
};

Why

Schema derivation remains inspectable before record construction.

Ownership and lifetime

getSchemaFields walks the supplied ASTs immediately and returns fresh required/optional field arrays containing the discovered Schema references.

Source