@metreeca/blue - v0.9.1
    Preparing search index...

    Interface Range<T, L, U>

    Shape for a set of values linked from a resource by a property.

    Combines a value shape with cardinality constraints to define how many values of a given type a property may have.

    interface Range<
        T = unknown,
        L extends undefined | number = undefined | number,
        U extends undefined | number = undefined | number,
    > {
        kind: "range";
        minCount?: L;
        maxCount?: U;
        shape: (ValueShape | Union<{ readonly [variant: string]: ValueShape; }>) & {
            model: T;
        };
    }

    Type Parameters

    • T = unknown

      The type for all values in the linked set

    • L extends undefined | number = undefined | number

      The minimum count constraint type

    • U extends undefined | number = undefined | number

      The maximum count constraint type

    Index

    Properties

    kind: "range"

    Discriminator identifying this as a range.

    minCount?: L

    Minimum number of values in the linked set.

    undefined (no minimum constraint, equivalent to 0)

    maxCount?: U

    Maximum number of values in the linked set.

    undefined (no maximum constraint)

    shape: (ValueShape | Union<{ readonly [variant: string]: ValueShape; }>) & {
        model: T;
    }

    Shape for all values in the linked set, or a union of value shapes for polymorphic values.