Skip to content

Interface: ResourcefulRouterOptions

Configuration options for the resourceful router macro

Properties

PropertyType
additionalAdditionalResourcefulRoutesMap
catchThrownboolean
domainstring | null | undefined
except( | "update" | "delete" | "index" | "create" | "read" | "readRelated" | "bulkUpdate" | "syncRelated")[]
externalDocs?ExternalDocumentationObject
headers{ [key: string]: string; }
infoInfoObject
middlewareOneOrMore< | MiddlewareFn | ParsedNamedMiddleware>
mutators?ResourcefulRouterMutatorOptions
onAny?(error: unknown) => void
onError?(error: Error) => void
onException?(error: Exception) => void
onJoiValidationError?(error: ValidationError) => void
onUnknown?(error: unknown) => void
onVineValidationError?(error: ValidationError) => void
payloadRestrictors?ResourcefulPayloadSchemaGetter[]
policies?ResourcefulPolicy[]
prefixstring
scopeRestrictors?ResourcefulQueryScopeCallback[]
securityResourcefulSecuritySchemaDefinition[]
tagMap{ additional: string; general: string; }
tagMap.additionalstring
tagMap.generalstring