Interface: ResourcefulMixinOptions<Model, ModelInstance>
Type Parameters
| Type Parameter | Default type |
|---|---|
Model extends LucidModel | LucidModel |
ModelInstance | InstanceType<Model> |
Properties
| Property | Type |
|---|---|
accessControlFilters | { create: ResourcefulGeneralAccessControlFilter[]; delete: ResourcefulResourceAccessControlFilter<Model, ModelInstance>[]; list: ResourcefulGeneralAccessControlFilter[]; read: ResourcefulResourceAccessControlFilter<Model, ModelInstance>[]; update: ResourcefulResourceAccessControlFilter<Model, ModelInstance>[]; } |
accessControlFilters.create | ResourcefulGeneralAccessControlFilter[] |
accessControlFilters.delete | ResourcefulResourceAccessControlFilter<Model, ModelInstance>[] |
accessControlFilters.list | ResourcefulGeneralAccessControlFilter[] |
accessControlFilters.read | ResourcefulResourceAccessControlFilter<Model, ModelInstance>[] |
accessControlFilters.update | ResourcefulResourceAccessControlFilter<Model, ModelInstance>[] |
advanced | AdvancedResourcefulMixinOptions |
cacheMiddlewareConsume? | CacheMiddlewareInput |
cacheMiddlewarePrepare? | CacheMiddlewareInput |
description? | string |
enforcedPreloads? | string[] |
example? | string |
externalDocs? | ExternalDocumentationObject |
name | string |
onACLError | "bubble" | "pass" | "fail" |
onRelationsCacheError? | RelationsCacheErrorHandler |
onRelationsCacheEvent? | RelationsCacheEventHandler |
onValidationScopeError | "bubble" | "pass" | "fail" |
payloadValidationSchemaBuilders | { create: ResourcefulPayloadValidatorGetter[]; update: ResourcefulPayloadValidatorGetter[]; } |
payloadValidationSchemaBuilders.create | ResourcefulPayloadValidatorGetter[] |
payloadValidationSchemaBuilders.update | ResourcefulPayloadValidatorGetter[] |
queryScopeCallbacks | { access: ResourcefulQueryScopeCallback[]; list: ResourcefulQueryScopeCallback[]; } |
queryScopeCallbacks.access | ResourcefulQueryScopeCallback[] |
queryScopeCallbacks.list | ResourcefulQueryScopeCallback[] |
readRequiredForWrite | boolean |
relationsCache? | Record<string, | boolean | Partial<Pick<RawCommonOptions, | "timeout" | "ttl" | "grace" | "graceBackoff" | "suppressL2Errors" | "hardTimeout" | "lockTimeout">>> |
relationsCacheDefaults? | Partial<Pick<RawCommonOptions, | "timeout" | "ttl" | "grace" | "graceBackoff" | "suppressL2Errors" | "hardTimeout" | "lockTimeout">> |
relationsCacheService? | RelationsCacheServiceResolver |
resourcefulTitleColumn? | string |