Function parseJsonWithShape

  • parseJsonWithShape<const Shape extends ShapeDefinition<any, any>>(
        json: string,
        shape: Readonly<Shape>,
    ): Shape["runtimeType"]

    Parse a JSON string and verify it against the given shape definition.

    Type Parameters

    Parameters

    • json: string
    • shape: Readonly<Shape>

    Returns Shape["runtimeType"]

    Example

    import {parseJsonWithShape, defineShape} from 'object-shape-tester';

    const result = parseJsonWithShape('{"a": "hello"}', defineShape({a: ''}));

    Throws

    If the parsed JSON does not match the shape definition or if the JSON parsing throws an error.

Settings

Member Visibility