@nhtio/lucid-resourceful/definitions

Column Data Type Definition Helpers for Resourceful Lucid Models

Interfaces

Interface	Description
ResourcefulArrayType	Instance type for ResourcefulArrayType with validated properties. Represents arrays with typed items and validation constraints as defined in the OpenAPI 3.0 specification.
ResourcefulBigintType	Instance type for ResourcefulBigintType with validated properties. Represents 64-bit signed integers as defined in the OpenAPI 3.0 specification.
ResourcefulBinaryType	Instance type for ResourcefulBinaryType with validated properties. Represents binary data as base64-encoded string as defined in the OpenAPI 3.0 specification.
ResourcefulBooleanType	Instance type for ResourcefulBooleanType with validated properties. Represents boolean true/false values as defined in the OpenAPI 3.0 specification.
ResourcefulDateTimeType	Instance type for ResourcefulDateTimeType with validated properties. Represents a date-time value formatted as ISO 8601 date-time string as defined in the OpenAPI 3.0 specification.
ResourcefulDateType	Instance type for ResourcefulDateType with validated properties. Represents a date-only value formatted as ISO 8601 date string as defined in the OpenAPI 3.0 specification.
ResourcefulIntegerType	Instance type for ResourcefulIntegerType with validated properties. Represents 32-bit signed integers as defined in the OpenAPI 3.0 specification.
ResourcefulNumberType	Instance type for ResourcefulNumberType with validated properties. Represents floating-point numbers as defined in the OpenAPI 3.0 specification.
ResourcefulObjectType	Instance type for ResourcefulObjectType with validated properties. Represents complex object schemas with typed properties as defined in the OpenAPI 3.0 specification.
ResourcefulStringType	Instance type for ResourcefulStringType with validated properties. Represents a string data type with validation constraints as defined in the OpenAPI 3.0 specification.
ResourcefulUnsignedIntegerType	Instance type for ResourcefulUnsignedIntegerType with validated properties. Represents unsigned integers as defined in the OpenAPI 3.0 specification.

Variables

Variable	Description
ResourcefulArrayType	Callable constructor for creating validated array type instances. Supports arrays with typed items and validation constraints like minimum/maximum length.
ResourcefulBigintType	Callable constructor for creating validated bigint type instances. Automatically sets the OpenAPI format to 'int64' for 64-bit signed integers.
ResourcefulBinaryType	Callable constructor for creating validated binary type instances. Automatically sets the OpenAPI format to 'binary' for base64-encoded binary data.
ResourcefulBooleanType	Callable constructor for creating validated boolean type instances. Represents simple true/false values in OpenAPI schemas.
ResourcefulDateTimeType	Callable constructor for creating validated date-time type instances. Automatically sets the OpenAPI format to 'date-time' for ISO 8601 date-time strings.
ResourcefulDateType	Callable constructor for creating validated date type instances. Automatically sets the OpenAPI format to 'date' for ISO 8601 date strings.
ResourcefulIntegerType	Callable constructor for creating validated integer type instances. Automatically sets the OpenAPI format to 'int32' for 32-bit signed integers.
ResourcefulNumberType	Callable constructor for creating validated number type instances. Supports floating-point numbers with configurable precision and range constraints.
ResourcefulObjectType	Callable constructor for creating validated object type instances. Supports complex nested object schemas with property validation and constraints.
ResourcefulStringType	Callable constructor for creating validated string type instances. Supports both constructor and function call patterns for flexible usage.
ResourcefulUnsignedIntegerType	Callable constructor for creating validated unsigned integer type instances. Represents unsigned integers without a specific OpenAPI format constraint.