Function assertPathExists

Assert that path exists on input, optionally checking the value at that path with predicate.

Example

const input = { a: { b: 1 } };

assertPathExists(input, 'a.b'); // does not throw
assertPathExists(input, 'a.b', (value): value is number => typeof value === 'number'); // does not throw
assertPathExists(input, 'c'); // throws Error: object path (c) does not exist on input

assertPathExists<Input extends object, InputPath extends string | number>(
    input: Input,
    path: InputPath,
): asserts input is Input & {
    [Property in string | number | symbol]: (
        Input & Merge<Input, FromPath<InputPath, unknown>>
    )[Property]
}
Type Parameters
- Input extends object
- InputPath extends string | number
Parameters
- input: Input
- path: InputPath
Returns asserts input is Input & {
    [Property in string | number | symbol]: (
        Input & Merge<Input, FromPath<InputPath, unknown>>
    )[Property]
}
- Defined in src/assertion/assertPathExists.ts:7
assertPathExists<Input extends object, InputPath extends string | number, Value>(
    input: Input,
    path: InputPath,
    predicate: TypePredicateFn<Value>,
): asserts input is Input & {
    [Property in string | number | symbol]: (
        Input & Merge<Input, FromPath<InputPath, Value>>
    )[Property]
}
Type Parameters
- Input extends object
- InputPath extends string | number
- Value
Parameters
- input: Input
- path: InputPath
- predicate: TypePredicateFn<Value>
Returns asserts input is Input & {
    [Property in string | number | symbol]: (
        Input & Merge<Input, FromPath<InputPath, Value>>
    )[Property]
}
- Defined in src/assertion/assertPathExists.ts:12

Function assertPathExists

Example

Type Parameters

Parameters

Returns asserts input is Input & { [Property in string | number | symbol]: ( Input & Merge<Input, FromPath<InputPath, unknown>> )[Property]}

Type Parameters

Parameters

Returns asserts input is Input & { [Property in string | number | symbol]: ( Input & Merge<Input, FromPath<InputPath, Value>> )[Property]}

Settings

Returns asserts input is Input & {
[Property in string | number | symbol]: (
Input & Merge<Input, FromPath<InputPath, unknown>>
)[Property]
}

Returns asserts input is Input & {
[Property in string | number | symbol]: (
Input & Merge<Input, FromPath<InputPath, Value>>
)[Property]
}