Skip to content

unacy / validateRecordSchema

Function: validateRecordSchema()

ts
function validateRecordSchema(value, visited?): value is RecordSchema;

Defined in: packages/core/src/utils/validation.ts:190

Validate that a runtime value is a valid record schema.

A valid record schema is a plain object whose leaf values are primitive type name strings ('number', 'string', 'boolean', 'bigint') or nested record schema objects. Empty objects are accepted.

Parameters

ParameterTypeDescription
valueunknownThe value to validate
visitedSet<unknown>Internal set for circular reference detection

Returns

value is RecordSchema

true if value is a valid RecordSchema

Throws

If circular references or invalid type names are found

Example

typescript
validateRecordSchema({ x: 'number', y: 'number' }); // true
validateRecordSchema({ pos: { x: 'number' } }); // true (nested)

Released under the MIT License.