Function assertValidShape

assertValidShape<
    Shape extends ShapeDefinition<any, IsReadonly>,
    IsReadonly extends boolean,
>(
    subject: unknown,
    shapeDefinition: Shape,
    options?: PartialWithUndefined<CheckShapeValidityOptions>,
    failureMessage?: string,
): asserts subject is Shape["runtimeType"]
Assets that a variable matches the given shape.
Type Parameters
- Shape extends ShapeDefinition<any, IsReadonly>
- IsReadonly extends boolean
Parameters
- subject: unknown
- shapeDefinition: Shape
- options: PartialWithUndefined<CheckShapeValidityOptions> = {}
- failureMessage: string = ''
Returns asserts subject is Shape["runtimeType"]
Example
```
import {defineShape, assertValidShape} from 'object-shape-tester';

const myShape = defineShape({
    a: '',
});

assertValidShape({a: 'hi'}, myShape); // succeeds
assertValidShape({a: 'hi', b: 'bye'}, myShape, {allowExtraKeys: true}); // succeeds
assertValidShape({a: 3, myShape}); // fails
```
Throws
ShapeMismatchError If there is a mismatch
- Defined in src/verify-shape/verify-shape.ts:170