ow/dist/utils/match-shape.d.ts

Function argument validation for humans

import { optionalSymbol, absentSymbol } from '../predicates/base-predicate.js';
import type { BasePredicate } from '../index.js';
export type Shape = {
    [key: string]: BasePredicate | Shape;
};
/**
Extracts a regular type from a shape definition.

@example
```
const myShape = {
    foo: ow.string,
    bar: {
        baz: ow.boolean
    }
}

type X = TypeOfShape<typeof myShape> // {foo: string; bar: {baz: boolean}}
```

This is used in the `ow.object.partialShape(…)` and `ow.object.exactShape(…)` functions.
*/
export type TypeOfShape<S extends BasePredicate | Shape> = S extends BasePredicate<infer X> ? X extends object ? X : never : S extends Shape ? {
    [K in keyof S as S[K] extends {
        [absentSymbol]: true;
    } ? never : S[K] extends {
        [optionalSymbol]: true;
    } ? never : K]: TypeOfShape<S[K]>;
} & {
    [K in keyof S as S[K] extends {
        [absentSymbol]: true;
    } ? K : never]?: TypeOfShape<S[K]>;
} & {
    [K in keyof S as S[K] extends {
        [optionalSymbol]: true;
    } ? S[K] extends {
        [absentSymbol]: true;
    } ? never : K : never]: TypeOfShape<S[K]> | undefined;
} : never;
/**
Test if the `object` matches the `shape` partially.

@hidden

@param object - Object to test against the provided shape.
@param shape - Shape to test the object against.
@param parent - Name of the parent property.
*/
export declare function partial(object: Record<string, unknown>, shape: Shape, parent?: string): boolean | string;
/**
Test if the `object` matches the `shape` exactly.

@hidden

@param object - Object to test against the provided shape.
@param shape - Shape to test the object against.
@param parent - Name of the parent property.
*/
export declare function exact(object: Record<string, unknown>, shape: Shape, parent?: string, isArray?: boolean): boolean | string;