Skip to content

@nhtio/lucid-resourceful

Main Navigation Home Quick Start API

Appearance

Sidebar Navigation

Quick Start

Configuration

Decorators

Introduction

resourcefulColumn

resourcefulComputed

resourcefulBelongsTo

resourcefulHasOne

resourcefulHasMany

resourcefulHasManyThrough

resourcefulManyToMany

Data Type Definitions

Introduction

ResourcefulArrayType

ResourcefulBigintType

ResourcefulBinaryType

ResourcefulBooleanType

ResourcefulDateTimeType

ResourcefulDateType

ResourcefulIntegerType

ResourcefulNumberType

ResourcefulObjectType

ResourcefulStringType

ResourcefulUnsignedIntegerType

Validation

Error handling

CRUD operations

OpenAPI functionality

Helpers and Utilities

Routing

Resourceful

OData

API

@nhtio/lucid-resourceful

Package Exports

Interfaces

CacheMiddlewareContext

CacheMiddlewarePipeline

Type Aliases

CacheMiddlewareHandler

CacheMiddlewareInput

CacheMiddlewarePhase

Variables

resourcefulRouterMacro

version

Functions

registerRelationCacheTargetsForModel

resourcefulBelongsTo

resourcefulColumn

resourcefulComputed

resourcefulHasMany

resourcefulHasManyThrough

resourcefulHasOne

resourcefulManyToMany

withResourceful

@nhtio/lucid-resourceful/definitions

Package Exports

Interfaces

ResourcefulArrayType

ResourcefulBigintType

ResourcefulBinaryType

ResourcefulBooleanType

ResourcefulDateTimeType

ResourcefulDateType

ResourcefulIntegerType

ResourcefulNumberType

ResourcefulObjectType

ResourcefulStringType

ResourcefulUnsignedIntegerType

Variables

ResourcefulArrayType

ResourcefulBigintType

ResourcefulBinaryType

ResourcefulBooleanType

ResourcefulDateTimeType

ResourcefulDateType

ResourcefulIntegerType

ResourcefulNumberType

ResourcefulObjectType

ResourcefulStringType

ResourcefulUnsignedIntegerType

@nhtio/lucid-resourceful/encoding

Package Exports

Classes

E_CIRCULAR_REFERENCE

E_INCOMPATIBLE_VERSION

E_INVALID_VERSION

E_NOT_AN_ENCODED_VALUE

E_UNDECODABLE_VALUE

E_UNENCODABLE_VALUE

FunctionSerializer

Interfaces

BaseException

Type Aliases

DehydratedFunctionValue

Encodable

Variables

decode

encode

version

@nhtio/lucid-resourceful/errors

Package Exports

Classes

CHECK_CONSTRAINT_VIOLATION

DATA_VALIDATION_ERROR

DATABASE_CONNECTION_ERROR

DEADLOCK

DIVISION_BY_ZERO

E_BULK_UPDATE_SEARCH_UNKNOWN_EXCEPTION

E_EXPAND_NOT_IMPLEMENTED

E_FORBIDDEN

E_FORBIDDEN_PAYLOAD_EXCEPTION

E_INVALID_AGGREGATION_FIELD

E_INVALID_AGGREGATION_OPERATION

E_INVALID_COLUMN_ACCESS

E_INVALID_ENTITYSET_IDENTIFIERS

E_INVALID_LUCENE_QUERY

E_INVALID_PAYLOAD_EXCEPTION

E_INVALID_RELATIONSHIP_EXCEPTION

E_INVALID_RESOURCEFUL_DATA_TYPE_OPTIONS

E_INVALID_RESOURCEFUL_DECORATOR_OPTIONS

E_INVALID_RESOURCEFUL_MIXIN_OPTIONS

E_INVALID_RESOURCEFUL_MODELS_MAP

E_INVALID_RESOURCEFUL_MODELS_MAP_AGGREGATE

E_INVALID_RESOURCEFUL_ROUTER_OPTIONS

E_INVALID_RESOUREFUL_INDEX_REQUEST_EXCEPTION

E_INVALID_RESOUREFUL_READ_RELATIONSHIP_REQUEST_EXCEPTION

E_LUCENE_INVALID_TYPE

E_LUCENE_REGEX_NOT_SUPPORTED

E_LUCENE_SYNTAX_EXCEPTION

E_LUCENE_UNEXPECTED_EXCEPTION

E_MISSING_PRIMARY_KEY_EXCEPTION

E_NOT_IN_MODEL_CONTEXT

E_NOT_IN_ODATA_CONTEXT

E_ODATA_FILTER_EXPECTED_COLUMN_REFERENCE

E_ODATA_FILTER_INAPPLICABLE_NODE_TYPE

E_ODATA_FILTER_INVALID_COMPARISON_SIDE

E_ODATA_FILTER_UNEVALUATABLE_NODE_TYPE

E_ODATA_FILTER_UNEXPECTED_CHARACTER

E_ODATA_FILTER_UNEXPECTED_END_OF_INPUT

E_ODATA_FILTER_UNEXPECTED_TOKEN

E_ODATA_FILTER_UNEXPECTED_TYPE

E_ODATA_FILTER_UNKNOWN_COMPARISON_OPERATOR

E_ODATA_FILTER_UNKNOWN_LOGICAL_OPERATOR

E_ODATA_FILTER_UNSUPPORTED_FUNCTION_COMPARISON

E_ODATA_UNKNOWN_PARAMETER_ALIAS

E_RECORD_NOT_FOUND_EXCEPTION

E_RELATION_CACHE_EVICTION_FAILED

E_RELATION_CACHE_KEY_DIVERGENCE

E_RELATION_CACHE_OPERATION_FAILED

E_RELATION_CACHE_READ_FAILED

E_RELATION_CACHE_REHYDRATION_FAILED

E_RELATION_CACHE_RESOLUTION_FAILED

E_RELATION_CACHE_WRITE_FAILED

E_RELATIONSHIP_NOT_FOUND_EXCEPTION

E_RESOURCEFUL_ROUTER_MISCONFIGURED

E_UNACCEPTABLE_FORMAT

E_UNEXPECTED_COLUMN_IN_QUERY

E_UNRESOLVABLE_MODEL

E_UNSUPPORTED_DATABASE_DIALECT

E_UNSYNCABLE_RELATIONSHIP_EXCEPTION

FOREIGN_KEY_VIOLATION

INVALID_DATA_TYPE

LOCK_TIMEOUT

NOT_NULL_VIOLATION

PERMISSION_DENIED

QUERY_SYNTAX_ERROR

SCHEMA_ERROR

SERIALIZATION_FAILURE

UNIQUE_CONSTRAINT_VIOLATION

Interfaces

RelationCacheErrorContext

Variables

E_ENCODED_BODY_PARSING_FAILED

E_INVALID_CONSUMED_VALUE

E_INVALID_HTTP_METHOD_EXCEPTION

E_INVALID_PREPARED_VALUE

E_MISSING_CURRENT_INSTANCE_ID

E_ROUTE_NOT_FOUND

E_UNCASTABLE

@nhtio/lucid-resourceful/integration/middlewares/odata_error

Package Exports

Classes

default

@nhtio/lucid-resourceful/integration/middlewares/resourceful_encoded_request

Package Exports

Classes

default

@nhtio/lucid-resourceful/integration/middlewares/resourceful_error

Package Exports

Classes

default

@nhtio/lucid-resourceful/integration/provider

Package Exports

Classes

default

@nhtio/lucid-resourceful/joi

Package Exports

Namespaces

address

Interfaces

Analysis

DomainOptions

EmailOptions

Variables

errorCodes

Functions

analyzeDomain

analyzeEmail

ipRegex

isDomainValid

isEmailValid

uriDecode

uriRegex

validateDomainOptions

formula

Namespaces

Options

Classes

Parser

Interfaces

Options

guards

Variables

isArray

isDateObjectUnits

isInstanceOf

isLuxonDateTime

isPlainObject

location

Interfaces

Location

Interfaces

AddRuleOptions

AlternativesSchema

AnySchema

ArraySchema

ArraySortOptions

ArrayUniqueOptions

AsyncValidationOptions

Base64Options

BaseValidationOptions

BigIntSchema

BinarySchema

BooleanSchema

Cache

CacheConfiguration

CacheProvisionOptions

CoerceObject

CoerceResult

CompileOptions

Context

CreateErrorOptions

CustomHelpers

DatabaseQueryBuilderContract

DataUriOptions

DateSchema

DatetimeSchema

DbValidationOptions

DependencyOptions

Description

DomainOptions

EmailOptions

Err

ErrorFormattingOptions

ErrorReport

ErrorValidationOptions

Extension

ExtensionFlag

ExtensionRule

ExtensionTerm

ExtensionTermManifest

ExternalHelpers

FunctionSchema

GetRuleOptions

GuidOptions

HexOptions

HierarchySeparatorOptions

I18nCallback

IpOptions

IsSchemaOptions

KnexConnectionConfigurations

LanguageMessageTemplate

LinkSchema

ModifyOptions

MutateRegisterOptions

NumberSchema

ObjectPatternOptions

ObjectSchema

PhoneSchema

QueryClientContract

Reference

ReferenceOptions

RenameOptions

Root

RuleArgs

RuleOptions

SchemaInternals

SetFlagOptions

SetI18nCallback

State

StringRegexOptions

StringSchema

SwitchCases

SwitchDefault

SymbolSchema

TopLevelDomainOptions

UriOptions

ValidationContext

ValidationError

ValidationErrorItem

ValidationOptions

ValidationRoot

ValidationWarning

WhenOptions

WhenSchemaOptions

Type Aliases

_ToObjectOutput

_ToObjectUnit

BasicType

CoerceFunction

ComparatorFunction

Country

CountryOrUnknown

CustomValidator

DefaultableValue

ExtensionBoundSchema

ExtensionFactory

ExternalValidationFunction

GuidVersions

IsNonPrimitiveSubsetUnion

IsPrimitiveSubset

IsUnion

KnexConfig

KnexInstance

KnexQueryBuilder

KnexSchemaConnection

KnexTransaction

LanguageMessages

NoNestedArrays

NullableType

ObjectPropertiesSchema

PartialSchemaMap

PhoneTypes

PresenceMode

Primitives

QueryBuilder

QueryClient

RuleMethod

Schema

SchemaFunction

SchemaLike

SchemaLikeWithoutArray

SchemaMap

StrictSchemaMap

Types

UnwrapSchemaLikeWithoutArray

ValidationErrorFunction

ValidationResult

Variables

decode

encode

PhoneTypes

tlds

ValidationError

validator

version

Functions

location

@nhtio/lucid-resourceful/odata/context

Package Exports

Interfaces

ResolvedODataContext

Functions

useODataContext

@nhtio/lucid-resourceful/odata/macro

Package Exports

Functions

odataXmlResponseMacro

@nhtio/lucid-resourceful/private/lucid_augmentations

@nhtio/lucid-resourceful/private/utils/cache_error_handler

Package Exports

Type Aliases

RelationsCacheErrorHandler

Functions

getDefaultOnRelationsCacheError

reportRelationCacheError

resetDefaultOnRelationsCacheError

setDefaultOnRelationsCacheError

@nhtio/lucid-resourceful/private/utils/cache_event_handler

Package Exports

Interfaces

RelationCacheEventContext

Type Aliases

RelationCacheEvent

RelationsCacheEventHandler

Functions

getDefaultOnRelationsCacheEvent

reportRelationCacheEvent

resetDefaultOnRelationsCacheEvent

setDefaultOnRelationsCacheEvent

@nhtio/lucid-resourceful/private/utils/cache_service_resolver

Package Exports

Type Aliases

CacheDuration

CacheServiceLike

RelationCacheEntryOptions

RelationsCacheServiceResolver

Functions

getDefaultRelationsCacheService

isRelationCacheTarget

registerRelationCacheTarget

resetRelationCacheTargets

resolveRelationsCacheService

setDefaultRelationsCacheService

@nhtio/lucid-resourceful/router

@nhtio/lucid-resourceful/router/context

Package Exports

Functions

useResourcefulModelContext

@nhtio/lucid-resourceful/router/utils

Package Exports

Functions

getResourcefulModelCreatePayloadValidationSchema

@nhtio/lucid-resourceful/types

Package Exports

Namespaces

OpenAPIV3

Enumerations

HttpMethods

Interfaces

ApiKeySecurityScheme

ArraySchemaObject

BaseSchemaObject

CallbackObject

ComponentsObject

ContactObject

DiscriminatorObject

Document

EncodingObject

ExampleObject

ExternalDocumentationObject

HeaderObject

HttpSecurityScheme

InfoObject

LicenseObject

LinkObject

MediaTypeObject

NonArraySchemaObject

OAuth2SecurityScheme

OpenIdSecurityScheme

ParameterBaseObject

ParameterObject

PathsObject

ReferenceObject

RequestBodyObject

ResponseObject

ResponsesObject

SecurityRequirementObject

ServerObject

ServerVariableObject

TagObject

XMLObject

Type Aliases

ArraySchemaObjectType

NonArraySchemaObjectType

OperationObject

PathItemObject

SchemaObject

SecuritySchemeObject

Interfaces

AdditionalResourcefulRouteDetails

AdditionalResourcefulRoutesMap

AdvancedResourcefulMixinOptions

ApplicationService

BaseInterface

DateTime

ExternalDocumentationObject

GeneratedRoute

HttpContext

LocalResourcefulPropertyDefinition

LucidModel

ModelQueryBuilderContract

NormalizedAdditionalResourcefulRouteDetails

NormalizedAdditionalResourcefulRoutes

NormalizedResourcefulRouterOptions

ODataRouterMacro

ODataRouterService

OpenApiGeneratorService

ParsedNamedMiddleware

ResolvedResourcefulHttpContext

ResourcefulAccessControlFilter

ResourcefulArrayTypeOptions

ResourcefulBigintTypeOptions

ResourcefulBinaryTypeOptions

ResourcefulBooleanTypeOptions

ResourcefulColumnDefinition

ResourcefulComputedAccessorDefinition

ResourcefulDateTimeTypeOptions

ResourcefulDateTypeOptions

ResourcefulErrorMiddlewareHeaders

ResourcefulErrorMiddlewareOptions

ResourcefulFormattedError

ResourcefulFormattedErrorDetails

ResourcefulGeneralAccessControlFilter

ResourcefulHooks

ResourcefulIndexResponse

ResourcefulIndexResult

ResourcefulIntegerTypeOptions

ResourcefulMixinOptions

ResourcefulModel

ResourcefulModelColumnMetaSchema

ResourcefulModelComputedAccessorMetaSchema

ResourcefulModelMetaSchema

ResourcefulModelRelationshipMetaSchema

ResourcefulNumberTypeOptions

ResourcefulObjectTypeOptions

ResourcefulOpenAPISpec

ResourcefulPayloadSchemaGetter

ResourcefulPayloadValidatorGetter

ResourcefulPolicy

ResourcefulPropertyDefinition

ResourcefulQueryScopeCallback

ResourcefulRelationshipDefinition

ResourcefulResourceAccessControlFilter

ResourcefulRouterMacro

ResourcefulRouterModelMappedOptions

ResourcefulRouterModelOptions

ResourcefulRouterModelServiceOptions

ResourcefulRouterMutatorOptions

ResourcefulRouterOptions

ResourcefulSecuritySchemaDefinition

ResourcefulStringTypeOptions

ResourcefulUnsignedIntegerTypeOptions

RouteGeneratorService

RouterRegistrationService

ServableResourcefulIndexResult

ValidationScoper

Type Aliases

BaseClass

BaseModel

CallableNewable

ComputedOptions

Constructor

DataTypeColumnOptions

DataTypeComputedOptions

DateColumnOptions

EventMap

GetControllerHandlers

HasManyThroughRelationOptions

Key

LazyImport

Listener

LucidBinaryValue

LucidPlainObject

MacroModelsMap

MiddlewareAsClass

MiddlewareFn

ModelColumnOptions

NormalizeConstructor

OneOrMore

PromiseAble

Promised

RelatedModelRelationOptions

Resolvable

ResolvedModelsMap

ResourcefulACLOperationType

ResourcefulACLOperationType

ResourcefulDataType

ResourcefulEnum

ResourcefulEnumObject

ResourcefulErrorHandlerMethod

ResourcefulErrorHandlerMethod

ResourcefulErrorMiddlewareEvents

ResourcefulHttpVerb

ResourcefulIndexResponseHook

ResourcefulMixinEventMap

ResourcefulModelFieldRelationshipMeta

ResourcefulModelOpenApiRelatedSchema

ResourcefulModelOpenApiSchema

ResourcefulModelPropertyMetaSchema

ResourcefulModelRelationshipMeta

ResourcefulModelRelationshipMetaChoice

ResourcefulModelSerializableAttributes

ResourcefulPropertySchema

ResourcefulResponseFormat

ResourcefulRouterOperation

ResourcefulRouterOptionsExcludedFromModelOptions

ResourcefulRouterVerb

ResourcefulRouterVerbMetaOperation

ResourcefulScopeHooks

ResourcefulValidationHooks

ResourceResourcefulRecordResponse

ResourceResourcefulRecordResponseHook

RouteCallback

RouteFn

Schema

VineValidationError

Variables

odataRouterMacro

ResourcefulHttpVerb

ResourcefulResponseFormat

ResourcefulRouterOperation

ResourcefulRouterVerb

ResourcefulRouterVerbMetaOperation

@nhtio/lucid-resourceful/utils

Package Exports

Namespaces

casters

Functions

castValueAsArray

castValueAsBigint

castValueAsBinary

castValueAsBoolean

castValueAsDate

castValueAsDateTime

castValueAsInteger

castValueAsNumber

castValueAsObject

castValueAsString

castValueAsUnsignedInt

consumers

Functions

consumeArray

consumeBigint

consumeBinary

consumeBoolean

consumeDate

consumeDateTime

consumeInteger

consumeNumber

consumeObject

consumeString

consumeUnsignedint

guards

Variables

isArray

isBigInt

isBigIntTypedArray

isError

isInstanceOf

isLucidBinaryValue

isLuxonDateTime

isLuxonDuration

isLuxonInterval

isLuxonSystemZone

isMap

isNegativeZero

isNumber

isObject

isPhoneObject

isPrimitive

isSet

isTypedArray

isUniterableObject

Functions

isArrayBuffer

isBigint

isBigInt64Array

isBigUint64Array

isBoolean

isDataView

isDate

isException

isFloat32Array

isFloat64Array

isInt16Array

isInt32Array

isInt8Array

isJoiValidationError

isNonArraySchemaObject

isNotImplementedError

isNull

isRegExp

isResourcefulArrayType

isResourcefulBigintType

isResourcefulBinaryType

isResourcefulBooleanType

isResourcefulDateTimeType

isResourcefulDateType

isResourcefulIntegerType

isResourcefulModel

isResourcefulNumberType

isResourcefulObjectType

isResourcefulStringType

isResourcefulUnsignedIntegerType

isString

isStringContent

isUint16Array

isUint32Array

isUint8Array

isUint8ClampedArray

isUndefined

isVineValidationError

preparers

Functions

prepareArray

prepareBigint

prepareBinary

prepareBoolean

prepareDate

prepareDateTime

prepareInteger

prepareNumber

prepareObject

prepareString

prepareUnsignedint

On this page

formula

Namespaces

Namespace	Description
Options	-

Classes

Class	Description
Parser	Formula parser

Interfaces

Interface	Description
Options	-

Pager

Next pageQuick Start

Copyright © 2025-present New Horizon Technology LTD