@metreeca/qest - v0.10.0
    Preparing search index...

    Type Alias Probe

    Parsed Selection or Projection key.

    Structural representation of a Projection or Selection key, decomposing the encoded string form into its target, transform pipeline, and property path components. Projection and constraint probes share a single shape — the two are easily disambiguated after parsing by checking whether target is an Identifier or an Operator via isIdentifier.

    // Projection: "vendorName=vendor.name"
    { target: "vendorName", pipe: [], path: ["vendor", "name"] }

    // Constraint: ">=year:releaseDate"
    { target: ">=", pipe: ["year"], path: ["releaseDate"] }
    type Probe = {
        target: Identifier | Operator;
        pipe: readonly Transform[];
        path: readonly Identifier[];
    }
    Index

    Properties

    target pipe path

    Properties

    target: Identifier | Operator

    Projection binding identifier or constraint operator symbol.

    For projections, the Identifier portion of a Binding: the name before =. For constraints, the constraint Operator prefix.

    pipe: readonly Transform[]

    Transform pipeline.

    Ordered list of Transform names applied to the path-resolved value, in application order (right-to-left in source notation, left-to-right in this array).

    path: readonly Identifier[]

    Property path.

    Ordered list of Identifier steps navigating to the target value within a resource. An empty path denotes an aggregate over the root value.

    Settings

    Member Visibility

    On This Page

    Properties