Beignet API reference
    Preparing search index...

    Interface ParsedPathTemplate

    Parsed representation of a Beignet route path template.

    interface ParsedPathTemplate {
        keys: string[];
        normalizedPath: string;
        openApiPath: string;
        segments: PathTemplateSegment[];
        shapeKey: string;
    }
    Index

    Properties

    keys: string[]

    Dynamic parameter names in declaration order.

    normalizedPath: string

    Normalized Beignet path using :param dynamic syntax.

    openApiPath: string

    OpenAPI-compatible path using {param} syntax.

    Static and dynamic path segments.

    shapeKey: string

    Route shape used for ambiguity detection, ignoring dynamic parameter names.