Function assertValidShape

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

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

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