# Api Reference
search
@tsed/graphql
@tsed/mongoose
- MongooseModule
- MONGOOSE_SCHEMA
- MONGOOSE_SCHEMA_OPTIONS
- MONGOOSE_MODEL_NAME
- DynamicRef
- Indexed
- Model
- MongooseIndex
- MongoosePlugin
- ObjectID
- PostHook
- PreHookOptions
- PreHook
- Ref
- Schema
- MongooseSchema
- SchemaIgnore
- Select
- Trim
- Unique
- VirtualRef
- VirtualRefs
- MDBConnection
- IMDBOptions
- MongooseDocument
- MongooseModel
- MongooseModelOptions
- MongoosePreHookAsyncCB
- MongoosePreHookSyncCB
- MongoosePostErrorHookCB
- MongoosePostHookCB
- MongoosePreHook
- MongoosePostHook
- MongoosePluginOptions
- MongooseIndexOptions
- MongooseSchemaOptions
- MongooseSchemaTypes
- MongooseVirtualRefOptions
- ValidationErrorMiddleware
- PROVIDER_TYPE_MONGOOSE_MODEL
- MongooseModelRegistry
- registerModel
- MONGOOSE_CONNECTIONS
- MongooseService
- cleanProps
- createModel
- MongooseSchemaMetadata
- createSchema
- getSchema
- buildMongooseSchema
- createSchemaTypeOptions
- schemaOptions
- buildPreHook
- applySchemaOptions
@tsed/passport
- PassportModule
- Args
- Arg
- AuthenticateOptions
- Authenticate
- AuthorizeOptions
- Authorize
- Protocol
- ProtocolOptionsDecorator
- UserInfo
- IProtocol
- IProtocolOptions
- OnInstall
- OnVerify
- PassportMiddleware
- PROVIDER_TYPE_PROTOCOL
- ProtocolRegistry
- registerProtocol
- PassportSerializerService
- ProtocolsService
- getProtocolsFromRequest
@tsed/socketio
- SocketIOModule
- Args
- SocketHandlersBuilder
- Broadcast
- BroadcastOthers
- Emit
- Input
- InputAndBroadcast
- InputAndBroadcastOthers
- InputAndEmit
- IO
- Namespace
- Nsp
- Socket
- SocketErr
- SocketEventName
- SocketFilter
- SocketMiddleware
- SocketMiddlewareError
- SocketReturns
- SocketService
- SocketSession
- SocketUseAfter
- SocketUseBefore
- ISocketHandlerMetadata
- ISocketMiddlewareHandlerMetadata
- ISocketParamMetadata
- SocketProviderTypes
- ISocketProviderMetadata
- OnNamespaceInit
- SocketFilters
- SocketReturnsTypes
- getNspSession
- PROVIDER_TYPE_SOCKET_SERVICE
- SocketServiceRegistry
- registerSocketService
- SocketIOServer
- SocketIOService
@tsed/swagger
- SwaggerModule
- Deprecated
- OpenApiEndpointBuilder
- OpenApiModelSchemaBuilder
-
OpenApiPropertiesBuilder - OpenApiParamsBuilder
- HTTP_STATUS_MESSAGES
-
BaseParameter - Consumes
- Description
- Docs
- Example
- Hidden
- Name
-
Operation - Produces
-
Responses -
Returns -
ReturnsArray - Security
- Summary
- ISwaggerPaths
-
ISwaggerResponses - SwaggerUIOptions
- SwaggerSpec
- ISwaggerSettings
- OpenApiDefinitions
- OpenApiResponses
- SwaggerService
- parseSwaggerPath
- swaggerType
- swaggerApplyType
- getReducers
@tsed/testing
@tsed/di
- IInvokeOptions
- Container
- LocalsContainer
- Provider
-
ProviderStorable - INJECTABLE_PROP
- DI_PARAMS
- DI_PARAM_OPTIONS
- Configuration
- Constant
- Inject
- Injectable
- Intercept
- Interceptor
- IModuleOptions
- Module
- Opts
- OverrideProvider
-
OverrideService - Scope
- Service
- UseOpts
- Value
- InjectionError
- UndefinedTokenError
- IDIConfigurationOptions
- IDILogger
- IDIResolver
- IInjectableProperty
- IInjectablePropertyService
- IInjectablePropertyValue
- IInjectableProperties
- IInterceptor
- IInterceptorNextHandler
- IInterceptorContext
- IProvider
- InjectablePropertyType
- OnDestroy
- OnInit
- ProviderScope
- ProviderType
- RegistrySettings
- TokenProvider
- TypedProvidersRegistry
- GlobalProviderRegistry
- GlobalProviders
- registerProvider
- registerFactory
- registerValue
- registerService
- registerController
- registerInterceptor
- DIConfiguration
- InjectorService
@tsed/common
- loadInjector
- ConverterModule
- MvcModule
- PlatformModule
- Schema
- Description
- Example
- Name
- Returns
- ReturnsArray
- IConverterSettings
- IErrorsSettings
- ILoggerSettings
- IServerMountDirectories
-
IServerSettings - ServerSettingsService
- ArrayConverter
- DateConverter
- MapConverter
- PrimitiveConverter
- SetConverter
- SymbolConverter
- CONVERTER
- Converter
-
ModelStrict -
RequiredPropertyError - UnknownPropertyError
- IDeserializer
- IConverterIgnoreCB
- ISerializer
- IConverterOptions
- IConverter
- IPropertyOptions
- ConverterRegistry
- registerConverter
- ConverterService
- AUTO_MAP_KEYS
-
JsonSchema - AdditionalProperties
-
AllowTypes - Any
- Const
- Default
- Enum
- ExclusiveMaximum
- ExclusiveMinimum
- Format
-
IgnoreProperty - Ignore
- Integer
- MaxItems
- MaxLength
- MaxProperties
- Maximum
- MinItems
- MinLength
- MinProperties
- Minimum
- MultipleOf
- Pattern
- JsonProperty
- Property
-
PropertyDeserialize - OnDeserialize
- PropertyFn
-
PropertyName -
PropertySerialize - OnSerialize
-
PropertyType - CollectionOf
- Title
- UniqueItems
-
stubSchemaDecorator - GetSchemaOptions
-
JsonSchemaRegistry -
JsonSchemesRegistry -
JsonSchemesService -
decoratorSchemaFactory - getJsonSchema
- deleteSchema
- JSON_TYPES
- getJsonType
- HTTP_METHODS
- Allow
- Required
- RequiredValidationError
- TemplateRenderingError
- ValidationError
- HandlerType
-
IFilter - IInjectableParamSettings
- IMiddleware
- IMiddlewareError
- IParamOptions
- IPathMethod
- IResponseError
- IResponseOptions
- IResponseHeaders
- IResponseHeader
- PathParamsType
- AcceptMimesMiddleware
-
AuthenticatedMiddleware - EndpointConstructorOptions
- EndpointMetadata
- IHandlerConstructorOptions
- HandlerMetadata
- IParamConstructorOptions
-
IPipe -
ParamMetadata - ParamTypes
- PropertyMetadata
- DeserializerPipe
- ParseExpressionPipe
- ValidationPipe
-
EndpointRegistry - FilterRegistry
- registerFilter
- MiddlewareRegistry
- registerMiddleware
- IUseFilterOptions
-
ParamRegistry -
PropertyRegistry -
ParseService -
ValidationService - getStorableMetadata
- mapParamsOptions
- mapReturnedResponse
- ControllerBuilder
- Context
- IChildrenController
- ControllerProvider
- HandlerContext
- IRequestContextOptions
- RequestContext
- RequestLogger
- ParamValidationError
- UnknownFilterError
- IHandlerContext
- IParamContext
- IPlatformRouteOptions
- IPlatformDriver
- IRoute
- IRouteController
- IRouteDetails
- SendResponseMiddleware
- bindEndpointMiddleware
- statusAndHeadersMiddleware
- ControllerRegistry
- createFakeRawDriver
- Platform
- PlatformApplication
- PlatformDriver
- PlatformHandler
- PLATFORM_ROUTER_OPTIONS
- PlatformRouter
-
RouteService - PlatformBuilder
- IHttpFactory
- HttpServer
- IHttpsFactory
- HttpsServer
- AfterInit
- AfterListen
- AfterRoutesInit
- BeforeInit
- BeforeListen
- BeforeRoutesInit
- IHooks
- OnReady
- OnRequest
- OnResponse
- OnRoutesInit
-
OnServerReady - ContextMiddleware
- callHook
- cleanGlobPatterns
- createContainer
- createHttpServer
- listenHttpServer
- createHttpsServer
- listenHttpsServer
- createInjector
- createPlatformApplication
- getConfiguration
- mapConfiguration
- importComponents
- importFiles
- importProviders
- listenServer
- printRoutes
- setLoggerLevel
-
ServerLoader -
ExpressRouter - CaseSensitive
- ExpressApplication
- MergeParams
- ResponseView
- Render
- RouterSettings
-
ServerSettings - Strict
- IRouterSettings
- IServerLifecycle
- GlobalAcceptMimesMiddleware
- GlobalErrorHandlerMiddleware
- LogIncomingRequestMiddleware
- ResponseViewMiddleware
- PlatformExpressApplication
- PlatformExpressHandler
- PlatformExpressRouter
- ServeStaticService
- createExpressApplication
- PlatformTestInvokeOptions
- PlatformTest
- IControllerMiddlewares
- IControllerOptions
- Controller
-
Filter - Middleware
-
MiddlewareError -
OverrideMiddleware - AcceptMime
- IAuthOptions
- AuthOptions
-
Authenticated - ContentType
- EndpointFn
- IHeaderOptions
- IHeadersOptions
- mapHeaders
-
Header - locationMiddleware
- Location
- redirectMiddleware
- Redirect
-
ReturnType - All
- Get
- Post
- Put
- Delete
- Head
- Patch
- Options
- Status
- Use
- UseAfter
- UseAuth
- UseBefore
- UseBeforeEach
- BodyParams
- CookiesParams
- Cookies
- EndpointInfo
- Err
- HeaderParams
- Locals
- Next
- ParamFn
- PathParams
- RawPathParams
- QueryParams
- RawQueryParams
- Request
- Req
- Response
- Res
- ResponseData
- Session
- UseDeserialization
- UseParam
-
UseFilter - UseParamExpression
- UseParamType
- UsePipe
- UseType
- UseValidation
@tsed/testing-mongoose
@tsed/typeorm
@tsed/ajv
@tsed/core
- EntityOptions
- Entity
- Hooks
- Metadata
- ProxyMapSettings
-
ProxyMap -
ProxyRegistry - RegistryHook
- RegistryKey
- Registry
-
Storable - CLASS_STORE
- METHOD_STORE
- PROPERTY_STORE
- PARAM_STORE
- StoreMap
- Store
- Configurable
- Deprecated
- Enumerable
- NotConfigurable
- NotEnumerable
- Readonly
- StoreFn
- StoreMerge
- StoreSet
- Writable
- DecoratorParameters
- Env
- EnvTypes
- MetadataTypes
- Type
- ValueOf
- DecoratorTypes
- getDecoratorType
- decoratorTypeOf
- UnsupportedDecoratorType
- decoratorArgs
- decorateMethodsOf
- applyDecorators
- AnyDecorator
- useDecorators
- useMethodDecorator
- useMethodDecorators
- getConstructor
- constructorOf
- toStringConstructor
- getConstructorArgNames
- getClass
- classOf
- getClassOrSymbol
- primitiveOf
- isSymbol
- isString
- isNumber
- isBoolean
- isPrimitiveOrPrimitiveClass
- isPrimitive
- isArray
- isArrayOrArrayClass
- isCollection
- isDate
- isClassObject
- isPlainObject
- isObject
- isClass
- isFunction
- isArrowFn
- isNil
- isEmpty
- isPromise
- isStream
- getInheritedClass
- ancestorsOf
- isInheritedFrom
- nameOf
- nameOfClass
- nameOfSymbol
- descriptorOf
- inheritedDescriptorOf
- prototypeOf
- isEnumerable
- getKeys
- methodsOf
- applyBefore
- catchError
- cleanObject
- deepClone
- deepExtends
- deepMerge
- getValue
- setValue
- uniq
- uniqBy
@tsed/exceptions
- BadMapping
- BadRequest
- Conflict
- ExpectationFailed
- Forbidden
- Gone
- ImATeapot
- LengthRequired
- MethodNotAllowed
- MisdirectedRequest
- NotAcceptable
- NotFound
- PaymentRequired
- PreconditionFailed
- PreconditionRequired
- ProxyAuthentificationRequired
- RequestEntityTooLarge
- RequestHeaderFieldsTooLarge
- RequestTimeout
- RequestURITooLong
- RequestedRangeUnsatisfiable
- TooManyRequests
- Unauthorized
- UnavailabledForLegalReasons
- UnprocessableEntity
- UnsupportedMediaType
- UpgradeRequired
- Exception
- HTTPException
- MovedPermanently
- MovedTemporarily
- MultipleChoices
- NotModified
- PermanentRedirect
- SeeOther
- TemporaryRedirect
- TooManyRedirects
- UseProxy
- BadGateway
- BandwidthLimitExceeded
- GatewayTimeout
- InternalServerError
- NetworkAuthenticationRequired
- NotExtended
- NotImplemented
- ProxyError
- ServiceUnvailable
- VariantAlsoNegotiates
@tsed/multipartfiles
@tsed/platform-express
- Session & cookies
- Passport.js
- TypeORM
- Mongoose
- GraphQL
- Socket.io
- Swagger
- AJV
- Multer
- Serve static files
- Templating
- Throw HTTP Exceptions
- Customize 404
- AWS
- Jest
- Seq
- Controllers
- Providers
- Model
- Converters
- Middlewares
- Pipes
- Interceptors
- Authentication
- Hooks
- Injection scopes
- Custom providers
- Custom endpoint decorator
- Testing