Function assertValidShape

assertValidShape<SpecificShape extends TSchema | Shape>(
    this: void,
    value: unknown,
    shape: SpecificShape,
    options?: CheckShapeOptions,
    failureMessage?: string,
): asserts value is RuntimeTypeOf<SpecificShape>
Asserts that the given value matches the given shape.
Type Parameters
- SpecificShape extends TSchema | Shape
Parameters
- this: void
- value: unknown
- shape: SpecificShape
- options: CheckShapeOptions = {}
- OptionalfailureMessage: string
Returns asserts value is RuntimeTypeOf<SpecificShape>
Throws
ShapeMismatchError if value does not match the shape.
- Defined in shape/check-shape.ts:66