Skip to content
Search
K
Main Navigation
Getting started
Introduction
What is Ts.ED?
What's new in v8?
Capabilities
Installation
Create your first controller
Migration
Migrate from v7
Migrate v6 to v7
Migrate from Express
Documentation
Configuration
Controllers
DI & Providers
Models
Json Mapper
Middlewares
Pipes
Interceptors
Validation
Authentication
Hooks
Response filter
Exceptions
Logger
Context
Cache
Platform API
Command
Custom decorators
Templating
Session & Cookies
Testing
Upload files
Customize 404
Api references
Tutorials
Agenda
AJV
AWS
BullMQ
GraphQL
IORedis
Jest
Keycloak
MikroORM
Mongoose
Objection.js
OIDC
Passport.js
Prisma
Server-sent events
Serverless
Socket.io
Stripe
Swagger
Temporal
Terminus
TypeORM
Vike
Vitest
Plugins
8.0.7
Releases
v7 (maintenance)
v6 (obsolete)
v5 (obsolete)
Contributing
Team
Appearance
Return to top
Explore API references
Discover our API references (class, decorators, utils) and learn how to use them.
All
Decorator
Class
Enum
Function
Interface
Constant
Service
Type alias
@tsed/hooks
HookListener
HookRef
hooks
Hooks
@tsed/core
AbstractType
AnyDecorator
AnyPromiseResult
AnyToPromise
AnyToPromiseResponseTypes
DecoratorMethodParameters
DecoratorParameters
DecoratorTypes
Env
EnvTypes
Metadata
MetadataTypes
Relation
StaticMethodDecorator
Store
StoreFn
StoreMerge
StoreSet
Type
UnsupportedDecoratorType
ValueOf
@tsed/engines
AtplEngine
BracketEngine
DotEngine
DustEngine
EctEngine
EjsEngine
Engine
EngineOptions
HamlCoffeeEngine
HamlEngine
HamletEngine
HandlebarsEngine
HoganEngine
HtmlingEngine
JazzEngine
JqtplEngine
JustEngine
LiquorEngine
LodashEngine
MoteEngine
MustacheEngine
NunjucksEngine
PlatesEngine
PugEngine
RactiveEngine
ReactEngine
SlmEngine
SquirrellyEngine
SwigEngine
TemplayedEngine
TwigEngine
TwingEngine
UnderscoreEngine
VashEngine
VelocityEngine
ViewEngine
ViewEngineOptions
WalrusEngine
@tsed/graphql-ws
GraphQLWSModule
GraphQLWSOptions
@tsed/apollo
AlterApolloContext
AlterApolloServerPlugins
AlterApolloSettings
ApolloContext
ApolloCustomServerCB
ApolloMiddlewareOptions
ApolloModule
ApolloServerOptionsBase
ApolloService
ApolloSettings
ApolloSettingsWithID
DataSource
DataSourceService
InjectApolloContext
@tsed/mikro-orm
AfterTransactionCommit
BeforeTransactionCommit
DEFAULT_CONTEXT_NAME
Em
entityManager
EntityManager
MikroOrmContext
MikroOrmFactory
MikroOrmModule
MikroOrmRegistry
OptimisticLockErrorFilter
orm
Orm
RetryStrategy
Subscriber
SUBSCRIBER_INJECTION_TYPE
Transactional
TransactionalInterceptor
TransactionOptions
@tsed/platform-serverless-testing
createFakeContext
createFakeEvent
LambdaClientRequest
LambdaPromiseResult
PlatformServerlessTest
@tsed/jwks
generateJwks
getJwks
JwksKeyParameters
JwksOptions
@tsed/oidc-provider
AccessToken
AuthorizationCode
BackchannelAuthenticationRequest
ClientCredentials
DefaultPolicy
DeviceCode
Grant
GrantId
Interaction
InteractionMethods
Interactions
InteractionsOptions
NoCache
OidcAccountsMethods
OidcAdapterMethods
OidcAdapters
OidcBadInteractionName
OidcClient
OIDCContext
OidcCtx
OidcInteraction
OidcInteractionContext
OidcInteractionMethods
OidcInteractionMiddleware
OidcInteractionOptions
OidcInteractionPromptProps
OidcInteractions
OidcJwks
OidcModule
OidcNoCacheMiddleware
OidcPolicy
OidcProvider
OidcSecureMiddleware
OidcSession
OidcSettings
Params
Prompt
RefreshToken
Uid
@tsed/oidc-provider-plugin-wildcard-redirect-uri
OidcWildcardRedirectUriModule
@tsed/swagger
Docs
ROOT_DIR
SWAGGER_UI_DIST
SwaggerModule
SwaggerOS2Settings
SwaggerOS3Settings
SwaggerService
SwaggerSettings
SwaggerSettingsBase
SwaggerUIOptions
@tsed/agenda
Agenda
AgendaModule
AgendaService
AgendaStore
Define
DefineOptions
Every
EveryOptions
@tsed/bullmq
BullMQConfig
BullMQModule
FallbackJobController
InjectQueue
InjectWorker
JobController
JobDispatcher
JobDispatcherOptions
JobMethods
JobStore
@tsed/event-emitter
EventEmitterModule
EventEmitterService
EventEmitterStore
OnAny
OnEvent
@tsed/formio
Action
ActionCtx
ActionMethods
Alter
AlterActions
AlterAudit
AlterHook
AlterHost
AlterLog
AlterSkip
AlterTemplateExportSteps
AlterTemplateImportSteps
Formio
FormioActionModel
FormioActionModelCtor
FormioActionMongooseSchema
FormioActions
FormioActionsIndex
FormioAuth
FormioAuthMiddleware
FormioAuthService
FormioBase
FormioBaseModel
FormioConfig
FormioCtxMapper
FormioDatabase
FormioDecodedToken
FormioEmailConfig
FormioErrors
FormioExportOptions
FormioHook
FormioHooks
FormioHooksService
FormioInitEvent
FormioInstaller
FormioJs
FormioJwtConfig
FormioMapper
FormioMiddlewares
FormioModel
FormioModels
FormioModelsModels
FormioModule
FormioMongooseSchema
FormioPayloadToken
FormioRepository
FormioRouter
FormioSchemas
FormioService
FormioSettings
FormioTemplate
FormioTemplateUtil
FormioUpdate
FormioUtil
On
OnHook
ResourceHttpHandler
ResourceHttpMethodOptions
ResourceRestOptions
SetActionItemMessage
UseFormioAuth
WithID
@tsed/normalize-path
normalizePath
@tsed/pulse
Define
DefineOptions
Every
EveryOptions
Pulse
PulseModule
PulseService
PulseStore
@tsed/terminus
Health
TerminusModule
TerminusSettings
@tsed/temporal
Activity
ActivityOptions
PROVIDER_TYPE_TEMPORAL
Temporal
TEMPORAL_STORE_KEY
TemporalClient
TemporalConnection
TemporalModule
TemporalStore
@tsed/vike
Vite
VITE_SERVER
ViteConfig
ViteModule
VitePageProps
ViteRenderContext
ViteRendererMiddleware
ViteService
@tsed/typegraphql
ContextMiddleware
ResolverController
ResolverControllerOptions
@tsed/di
AlterRunInContext
AutoInjectable
BaseContext
bindConstant
BindInjectablePropertyOpts
bindIntercept
bindValue
cleanAllLocalsContainer
configuration
Configuration
CONFIGURATION
constant
Constant
Container
context
contextLogger
ContextLogger
ContextLoggerOptions
controller
Controller
ControllerMiddlewares
ControllerOptions
ControllerProvider
destroyInjector
detachLocalsContainer
DIConfiguration
DIConfigurationOptions
DIContext
DIContextOptions
DILogger
DILoggerOptions
DITest
getInterceptorOptions
ImportTokenProviderOpts
inject
Inject
injectable
Injectable
InjectablePropertyType
InjectContext
InjectionError
injectMany
injector
InjectorService
Intercept
interceptor
Interceptor
InterceptorContext
InterceptorMethods
InterceptorNext
InvalidPropertyTokenError
invokeOptions
InvokeOptions
lazyInject
LazyInject
localsContainer
LocalsContainer
logger
LOGGER
Module
ModuleOptions
OnDestroy
OnInit
optionalLazyInject
OptionalLazyInject
Opts
OverrideProvider
PathType
Provider
ProviderHookCallback
ProviderOpts
ProviderScope
ProviderType
refValue
ResolvedInvokeOptions
Scope
Service
TokenProvider
TokenRoute
TransformInjectedProviderCB
UseAsyncFactoryImportTokenProviderOpts
UseClassImportTokenProviderOpts
UseFactoryImportTokenProviderOpts
UseImportTokenProviderOpts
UseOpts
Value
@tsed/adapters
adapter
Adapter
AdapterConstructorOptions
AdapterInvokeOptions
AdapterModel
Adapters
AdaptersSettings
FileSyncAdapter
FileSyncAdapterConstructorOptions
Indexed
InjectAdapter
LowDbAdapter
LowModel
MemoryAdapter
@tsed/mongoose
Auto
Decimal128
DecimalFormat
DynamicRef
ExcludeIndexes
Expires
Immutable
Indexed
Lowercase
Model
MongooseConnectionOptions
MongooseDocument
MongooseDocumentMethods
MongooseHookOptions
MongooseHookPromised
MongooseIndex
MongooseIndexes
MongooseIndexOptions
MongooseMergedDocument
MongooseModel
MongooseModelOptions
MongooseNextCB
MongoosePlugin
MongoosePluginOptions
MongoosePostHook
MongoosePostHookCB
MongoosePreHook
MongoosePreHookCB
MongooseSchema
MongooseSchemaOptions
MongooseSchemaTypes
MongooseService
MongooseVirtualRefOptions
NumberDecimal
ObjectID
PostHook
PreHook
Ref
Schema
SchemaIgnore
Select
Sparse
Text
Trim
Unique
Uppercase
VersionKey
VirtualRef
VirtualRefs
@tsed/platform-http
adapter
AfterInit
AfterListen
AfterRoutesInit
AnyToPromiseWithCtx
application
BeforeInit
BeforeListen
BeforeRoutesInit
Err
FakeAdapter
FakeResponse
IncomingEvent
MulterException
MulterFileSize
MulterInputOptions
MulterOptions
MultipartFile
Next
OnReady
OnRequest
OnResponse
OnRoutesInit
PathOrStaticsOptions
Platform
PlatformAcceptMimesMiddleware
PlatformAdapter
PlatformApplication
PlatformBuilder
PlatformBuilderSettings
PlatformConfiguration
PlatformContext
PlatformContextOptions
PlatformHandler
PlatformJsonMapperSettings
PlatformMiddlewaresChain
PlatformMulter
PlatformMulterField
PlatformMulterFile
PlatformMulterMiddleware
PlatformMulterSettings
PlatformProvider
PlatformRequest
PlatformResponse
PlatformRouteDetails
PlatformRouterSettings
PlatformStaticsOptions
PlatformStaticsSettings
PlatformTest
Req
Request
Res
Response
ResponseErrorObject
Route
RouteController
@tsed/adapters-redis
OIDCRedisAdapter
RedisAdapter
RedisAdapterConstructorOptions
@tsed/ioredis
BaseIORedisConfiguration
ClusterConfiguration
IORedisConfiguration
ioRedisStore
IORedisStore
IORedisStoreCtrOptions
IORedisTest
RedisClusterConfig
@tsed/schema
AcceptMime
AdditionalProperties
All
AllOf
Allow
Any
AnyJsonSchema
anyMapper
AnyOf
ArrayOf
ArrayOfChainedDecorators
channelsMapper
Children
classMapper
CollectionContains
CollectionOf
CollectionOfChainedDecorators
Const
Consumes
ContentType
CustomKey
CustomKeys
DateFormat
DateTime
Default
DefaultMsg
Delete
Deprecated
Description
Discriminator
DiscriminatorKey
discriminatorMappingMapper
DiscriminatorValue
Email
EndpointMetadata
Enum
enumsMapper
ErrorMsg
Example
Examples
ExclusiveMaximum
ExclusiveMinimum
For
Format
ForwardGroups
GenericOf
GenericOfChainedDecorators
Generics
Get
Groups
Head
Header
Ignore
IgnoreCallback
In
InChainedDecorators
InFile
Integer
itemMapper
JsonClassStore
JsonEntityFn
JsonEntityStore
JsonEntityStoreOptions
JsonFormatTypes
JsonHeader
JsonHeaders
JsonHookContext
JsonLazyRef
JsonMap
JsonMedia
JsonMethodPath
JsonMethodStore
JsonOperation
JsonOperationOptions
JsonOperationPathsMap
JsonOperationRoute
JsonParameter
JsonParameterOptions
JsonParameterStore
JsonParameterStoreOptions
JsonParameterTypes
JsonPropertyStore
JsonRedirectOptions
JsonRequestBody
JsonRequestBodyOptions
JsonResponse
JsonResponseOptions
JsonSchema
JsonSchemaObject
JsonSchemaOptions
JsonViewOptions
lazyRefMapper
Location
MapOf
MapOfChainedDecorators
Max
Maximum
MaxItems
MaxLength
MaxProperties
messageMapper
Min
Minimum
MinItems
MinLength
MinProperties
MultipleOf
Name
Nullable
nullableMapper
nullableMapperOpenApi
ofMapper
OneOf
Operation
OperationId
operationInFilesMapper
operationInParameterMapper
operationInParametersMapper
operationInQueryMapper
operationMapper
operationMediaMapper
OperationPath
operationRequestBodyMapper
operationResponseMapper
Optional
Options
ParamMetadata
Partial
Patch
Path
pathsMapper
Pattern
payloadMapper
PipeMethods
Post
Produces
propertiesMapper
Property
PropertyMetadata
Publish
Put
ReadOnly
RecordOf
Redirect
Required
RequiredGroups
requiredMapper
responsePayloadMapper
Returns
ReturnsChainedDecorators
RouteChainedDecorators
Schema
schemaMapper
Security
SpecTypes
Status
Subscribe
Summary
Tags
TimeFormat
Title
TypeError
UniqueItems
Uri
Url
View
wrapEnumsMapper
WriteOnly
@tsed/schema-formio
anyToComponent
arrayToComponent
Component
Conditional
Currency
CustomClass
CustomConditional
CustomConditionalCtx
DataSourceJson
DataSourceUrl
defaultToComponent
enumToComponent
ErrorLabel
ErrorMessage
Form
FormioDataResolver
FormioDataResolverCtx
Hidden
HideWhen
InputTags
Label
mapToComponent
Mask
Masks
MaxWords
MinWords
ModalEdit
Multiple
nestedToComponent
numberToComponent
objectToEditGrid
OpenWhenEmpty
panelToComponent
Password
PasswordOpts
Placeholder
Prefix
propertiesToComponents
Select
SelectOpts
ShowWhen
stringToComponent
Suffix
TableView
Tabs
Textarea
TextareaOpts
TextCase
Tooltip
Validate
@tsed/objection
BelongsToOne
ColumnOptions
ColumnOpts
Decimal
DecimalOptions
Entity
EntityMethods
HasMany
HasOne
HasOneThroughRelation
IdColumn
isModelClassFactory
isRelationshipOptsWithThrough
ManyToMany
OBJECTION_CONNECTION
RelatesTo
RelationshipOpts
RelationshipOptsWithoutThrough
RelationshipOptsWithThrough
@tsed/testcontainers-mongo
getMongoConnectionOptions
getMongoConnectionsOptions
getMongoUrl
setup
startMongoServer
stopMongoServer
teardown
TestContainersMongo
@tsed/platform-cache
CacheManager
OnCreateCacheManager
PlatformCache
PlatformCachedObject
PlatformCacheInterceptor
PlatformCacheOptions
PlatformCacheSettings
Ttl
UseCache
@tsed/platform-exceptions
Catch
ErrorFilter
ExceptionFilter
ExceptionFilterMethods
MongooseErrorFilter
PlatformExceptions
ResourceNotFound
StringErrorFilter
@tsed/platform-express
PlatformExpress
PlatformExpressHandler
PlatformExpressSettings
PlatformExpressStaticsOptions
@tsed/platform-koa
Ctx
KoaCtx
PlatformKoa
PlatformKoaHandler
PlatformKoaRequest
PlatformKoaResponse
PlatformKoaSettings
State
@tsed/platform-log-middleware
LoggerRequestFields
PlatformLogMiddleware
PlatformLogMiddlewareSettings
@tsed/platform-log-request
AlterLogCallback
PlatformLogRequestFactory
PlatformLogRequestSettings
@tsed/platform-middlewares
AuthOptions
Middleware
MiddlewareMethods
PlatformMiddlewareLoadingOptions
PlatformMiddlewareSettings
Use
UseAfter
UseAuth
UseBefore
UseBeforeEach
@tsed/platform-params
BodyParams
Context
Cookies
CookiesParams
DeserializerPipe
HeaderParams
Locals
PARAM_TYPES_DATA_PATH
ParamFn
ParamOptions
ParamTypes
ParamValidationError
ParseExpressionPipe
PathParams
PlatformParams
PlatformParamsCallback
PlatformParamsScope
QueryParams
RawBodyParams
RawPathParams
RawQueryParams
RequiredValidationError
Session
UseDeserialization
UseParam
UseParamExpression
UseParamType
UsePipe
UseType
UseValidation
ValidationError
ValidationPipe
ValidatorServiceMethods
@tsed/platform-response-filter
PlatformResponseFilter
ResponseFilter
ResponseFilterMethods
TemplateRenderError
@tsed/platform-router
AlterEndpointHandlersArg
PlatformHandlerMetadata
PlatformHandlerMetadataOpts
PlatformHandlerMetadataProps
PlatformHandlerType
PlatformLayer
PlatformLayerOptions
PlatformLayerProps
PlatformRouter
PlatformRouters
SinglePathType
@tsed/platform-serverless
HeaderValue
PlatformServerless
PlatformServerlessHandler
PlatformServerlessSettings
RequestHandler
ServerlessContext
ServerlessContextOptions
ServerlessEvent
ServerlessRequest
ServerlessResponse
ServerlessResponseMeta
ServerlessResponseStream
@tsed/platform-serverless-http
PlatformServerlessHttp
ServerlessContext
ServerlessEvent
@tsed/platform-views
PLATFORM_VIEWS_EXTENSIONS
PlatformRenderOptions
PlatformViewEngine
PlatformViews
PlatformViewsEngineOptions
PlatformViewsExtensionsTypes
PlatformViewsSettings
PlatformViewWritableStream
View
@tsed/passport
Arg
Args
Authenticate
AuthenticateOptions
Authorize
AuthorizeOptions
BeforeInstall
OnInstall
OnVerify
PassportException
PassportMessage
PassportMiddleware
Protocol
ProtocolMethods
ProtocolOptions
ProtocolOptionsDecorator
PROVIDER_TYPE_PROTOCOL
UserInfo
@tsed/socketio
Args
Broadcast
BroadcastOthers
Emit
Input
InputAndBroadcast
InputAndBroadcastOthers
InputAndEmit
IO
Namespace
Nsp
OnNamespaceInit
RawSocketSession
Reason
Socket
SocketErr
SocketEventName
SocketFilter
SocketHandlerMetadata
SocketInjectableNsp
SocketIOServer
SocketIOService
SocketMiddleware
SocketMiddlewareError
SocketNsp
SocketParamMetadata
SocketProviderMetadata
SocketProviderTypes
SocketReturns
SocketService
SocketSession
SocketSessionData
SocketUseAfter
SocketUseBefore
@tsed/ajv
AjvDataValidateFunction
AjvDataValidationCtx
AjvErrorObject
AjvSchemaValidateFunction
AjvService
AjvValidateOptions
AjvValidationError
ErrorFormatter
Formats
FormatsMethods
FormatsOptions
IAjvSettings
Keyword
KeywordMethods
KeywordOptions
@tsed/exceptions
BadGateway
BadMapping
BadRequest
BandwidthLimitExceeded
ClientException
Conflict
Exception
ExpectationFailed
Forbidden
GatewayTimeout
Gone
HTTPException
ImATeapot
InternalServerError
LengthRequired
MethodNotAllowed
MisdirectedRequest
MovedPermanently
MovedTemporarily
MultipleChoices
NetworkAuthenticationRequired
NotAcceptable
NotExtended
NotFound
NotImplemented
NotModified
PaymentRequired
PermanentRedirect
PreconditionFailed
PreconditionRequired
ProxyAuthentificationRequired
ProxyError
RedirectException
RequestEntityTooLarge
RequestHeaderFieldsTooLarge
RequestRangeUnsatisfiable
RequestTimeout
RequestURITooLong
SeeOther
ServerException
ServiceUnavailable
StatusFamily
TemporaryRedirect
TooManyRequests
Unauthorized
UnavailableForLegalReasons
UnprocessableEntity
UnsupportedMediaType
UpgradeRequired
UseProxy
VariantAlsoNegotiates
@tsed/json-mapper
AfterDeserialize
AfterDeserializeCallback
BeforeDeserialize
BeforeDeserializeCallback
CachedGroupsJsonMapper
CachedJsonMapper
CastError
DateMapper
JsonDeserializer
JsonDeserializerOptions
JsonMapper
JsonMapperCallback
JsonMapperCompiler
JsonMapperCtx
JsonMapperGlobalOptions
JsonMapperMethods
JsonMapperNext
JsonMapperSettings
JsonSerializer
JsonSerializerOptions
OnDeserialize
OnDeserializeCallback
OnSerialize
OnSerializeCallback
PrimitiveMapper
SymbolMapper
Writer
@tsed/openspec
OpenSpec2
OpenSpec3
OpenSpecBaseJsonSchema
OpenSpecContact
OpenSpecExternalDocs
OpenSpecHash
OpenSpecInfo
OpenSpecJsonSchema
OpenSpecLicense
OpenSpecPath
OpenSpecRef
OpenSpecSecurity
OpenSpecServerVariable
OpenSpecTag
OpenSpecTypes
OpenSpecVersions
OpenSpecXML
OS2BaseFormatContrainedParameter
OS2BaseParameter
OS2BaseSchema
OS2BodyParameter
OS2FlowAccessCode
OS2FlowApplication
OS2FlowImplicit
OS2FlowPassword
OS2FormDataParameter
OS2GenericFormat
OS2Header
OS2HeaderParameter
OS2IntegerFormat
OS2NumberFormat
OS2Operation
OS2Parameter
OS2PathParameter
OS2Paths
OS2QueryParameter
OS2Response
OS2Schema
OS2SchemaFormatConstraints
OS2Security
OS2SecurityApiKey
OS2SecurityBase
OS2SecurityBasic
OS2SecurityOAuth
OS2StringFormat
OS2Versions
OS2XML
OS3BaseSchema
OS3Callbacks
OS3Components
OS3Encoding
OS3Example
OS3Flow
OS3FlowAuthorizationCode
OS3FlowClientCredentials
OS3FlowImplicit
OS3FlowPassword
OS3Flows
OS3Header
OS3Link
OS3MediaType
OS3Operation
OS3Parameter
OS3Paths
OS3RequestBody
OS3Response
OS3Schema
OS3Security
OS3SecurityApiKey
OS3SecurityBase
OS3SecurityHTTP
OS3SecurityOAuth2
OS3SecurityOpenIDConnect
OS3Server
OS3StyleParameter
OS3Versions
ParameterCollectionFormat
@tsed/formio-types
FormioAccess
FormioAction
FormioActionInfo
FormioActionItem
FormioComponent
FormioForm
FormioPermission
FormioRole
FormioSchema
FormioSubmission
FormioToken
@tsed/socketio-testing
SocketClientService
@tsed/sse
EventStream
EventStreamContext
EventStreamContextOptions
EventStreamCtx
EventStreamInterceptor
EventStreamMiddleware
EventStreamOpts
@tsed/stripe
StripeFactory
StripeSettings
WebhookEvent
WebhookEventMiddleware
WebhookEventOptions