Skip to main content
Faremeter API
Faremeter API / types/src

types/src

Namespaces

Functions

caseInsensitiveLiteral()

caseInsensitiveLiteral<T>(…l): instantiateType<normalizeMorphDistribution<_inferIntersection<(In) => To<string>, Lowercase<T>, true>, _inferIntersection<(In) => To<string>, Lowercase<T>, true> extends InferredMorph<i, Out<any>> ? i : never, _inferIntersection<(In) => To<string>, Lowercase<T>, true> extends InferredMorph<any, o> ? [o] extends [To<unwrappedOut>] ? To<unwrappedOut> : o : never>, { }> extends _ ? _ : never
Defined in: packages/types/src/literal.ts:11 Creates an arktype validator for case-insensitive string literals. Input strings are lowercased before matching against the allowed values.

Type Parameters

T
T extends string

Parameters

l
T[] The literal string values to accept (case-insensitive)

Returns

instantiateType<normalizeMorphDistribution<_inferIntersection<(In) => To<string>, Lowercase<T>, true>, _inferIntersection<(In) => To<string>, Lowercase<T>, true> extends InferredMorph<i, Out<any>> ? i : never, _inferIntersection<(In) => To<string>, Lowercase<T>, true> extends InferredMorph<any, o> ? [o] extends [To<unwrappedOut>] ? To<unwrappedOut> : o : never>, { }> extends _ ? _ : never An arktype validator that accepts any case variant of the literals

isValidationError()

isValidationError(possibleErrors): possibleErrors is ArkErrors
Defined in: packages/types/src/validation.ts:9 Type guard that checks if a value is an arktype validation error.

Parameters

possibleErrors
unknown The value to check

Returns

possibleErrors is ArkErrors True if the value is a validation error

throwValidationError()

throwValidationError(message, errors): never
Defined in: packages/types/src/validation.ts:22 Throws an error with the validation error messages appended.

Parameters

message
string Context message describing what was being validated
errors
ArkErrors The arktype validation errors

Returns

never

Throws

Error with the message and error details