module@warp-drive/core

Type createIncludeValidator()

function createIncludeValidator<T extends TypedRecordInstance>(): <U>(includes: _StringSatisfiesIncludes<U, Exclude<_ExtractUnion<3, T, true, NONE, NONE, 1>, NONE>>) => U;

Defined in: warp-drive-packages/core/src/types/record.ts:245

Creates a runtime validator function for comma-separated include strings, ensuring at compile time that only valid paths for T (per Includes) are supplied.

Type Parameters

T

T extends TypedRecordInstance

Returns

<U>(includes: _StringSatisfiesIncludes<U, Exclude<_ExtractUnion<3, T, true, NONE, NONE, 1>, NONE>>) => U

Example

import { createIncludeValidator } from '@warp-drive/core/types/record';

const userIncludesValidator = createIncludeValidator<User>;

userIncludesValidator('company,company.ceo,friends');