Function recordShape

recordShape<K, V, IsPartial extends boolean>(
    __namedParameters: {
        additionalProperties?: boolean;
        keys: K;
        partial?: IsPartial;
        values: V;
    },
): Shape<
    TUnsafe<
        IsEqual<IsPartial, true> extends true
            ? Partial<
                Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
            >
            : Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
    >,
>
Creates a shape that requires an object with certain keys and values.
Type Parameters
- K
- V
- IsPartial extends boolean
Parameters
- __namedParameters: { additionalProperties?: boolean; keys: K; partial?: IsPartial; values: V }
  - OptionaladditionalProperties?: boolean
    Set to true to allow additional properties in addition to the required properties.
    
    Default
    false
  - keys: K
  - Optionalpartial?: IsPartial
    If set to true, all keys are optional.
    
    Default
    false
  - values: V
Returns Shape<
    TUnsafe<
        IsEqual<IsPartial, true> extends true
            ? Partial<
                Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
            >
            : Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
    >,
>
Example
```
import {recordShape, checkValidShape} from 'object-shape-tester';

const myShape = recordShape({
    keys: '',
    values: -1,
});

checkValidShape({a: 0}, myShape); // `true`
checkValidShape({a: '0'}, myShape); // `false`
```
- Defined in custom-shapes/record.shape.ts:54

Function recordShape

Type Parameters

Parameters

`Optional`additionalProperties?: boolean

Default

keys: K

`Optional`partial?: IsPartial

Default

values: V

Returns Shape<
    TUnsafe<
        IsEqual<IsPartial, true> extends true
            ? Partial<
                Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
            >
            : Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
    >,
>

Example

Settings

Function recordShape

Type Parameters

Parameters

OptionaladditionalProperties?: boolean

Default

keys: K

Optionalpartial?: IsPartial

Default

values: V

Returns Shape< TUnsafe< IsEqual<IsPartial, true> extends true ? Partial< Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>, > : Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>, >,>

Example

Settings

`Optional`additionalProperties?: boolean

`Optional`partial?: IsPartial

Returns Shape<
TUnsafe<
IsEqual<IsPartial, true> extends true
? Partial<
Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
>
: Record<Extract<ShapeInitType<K>, PropertyKey>, ShapeInitType<V>>,
>,
>