Function indexedKeys

indexedKeys<Parts extends readonly [BaseIndexedKeys]>(
...parts: Parts,
): ShapeIndexedKeys<Parts>

Define a shape part that's an object with a specific set of keys and values.

Type Parameters

Parts extends readonly [BaseIndexedKeys]

Parameters

...parts: Parts

Returns ShapeIndexedKeys<Parts>

Example

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

const myShape = defineShape({
    a: indexedKeys({
        keys: or(exact('hi'), exact('bye')),
        values: {
            helloThere: 0,
        },
        required: false,
    }),
});

// `myShape.runtimeType` is `{a: Partial<Record<'hi' | 'bye', {helloThere: number}>>}`