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

    Type Alias BooleanShape<V>

    BooleanShape: BooleanConstraints<V> & { kind: "boolean" }

    Describes a truth value.

    Admits the JSON booleans a resource may carry, closed to a single one where the shape enumerates it and typed as an XSD 1.0 boolean, so that a validated value carries the datatype the shape states rather than the one JSON leaves unsaid.

    Inheritance

    Where a resource!ResourceShape extends the shapes it lists as parents, boolean-valued members are merged according to the following rules. The child is the extending shape; the parent is the inherited one.

    Field Override Rule
    kind Cannot be overridden
    in Must be strictly equal when both defined; the single defined value carries through

    A child restating the value its parent admits narrows nothing and is accepted all the same; a child admitting the other value would leave the member admitting nothing and is rejected.

    Type Parameters

    • V extends boolean = boolean

      The values the shape admits, narrowed to the enumerated one where it states an enumeration and both truth values otherwise

    Type Declaration

    • Readonlykind: "boolean"

      Discriminator identifying this as a boolean shape.

      Inheritance — cannot be overridden.