diff --git a/docs/api/index.md b/docs/api/index.md index 9f6fc3f58a..5ac2d631fc 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -7,61 +7,68 @@ * [strategy][FunctionDeclaration-2] * [PermissionRequired][FunctionDeclaration-3] * [LoginRequired][FunctionDeclaration-4] - * [isObjectDoesNotExist][FunctionDeclaration-5] - * [isPermissionDenied][FunctionDeclaration-6] - * [isValidationError][FunctionDeclaration-7] - * [Log][FunctionDeclaration-8] - * [ValidateBody][FunctionDeclaration-9] - * [ValidateHeaders][FunctionDeclaration-10] - * [ValidateParams][FunctionDeclaration-11] - * [ValidateQuery][FunctionDeclaration-12] - * [middleware][FunctionDeclaration-13] - * [controller][FunctionDeclaration-14] - * [escapeProp][FunctionDeclaration-15] - * [escape][FunctionDeclaration-16] - * [render][FunctionDeclaration-17] - * [validate][FunctionDeclaration-18] - * [Get][FunctionDeclaration-19] - * [Post][FunctionDeclaration-20] - * [Put][FunctionDeclaration-21] - * [Patch][FunctionDeclaration-22] - * [Delete][FunctionDeclaration-23] - * [isHttpResponse][FunctionDeclaration-24] - * [isHttpResponseSuccess][FunctionDeclaration-25] - * [isHttpResponseOK][FunctionDeclaration-26] - * [isHttpResponseCreated][FunctionDeclaration-27] - * [isHttpResponseNoContent][FunctionDeclaration-28] - * [isHttpResponseRedirection][FunctionDeclaration-29] - * [isHttpResponseRedirect][FunctionDeclaration-30] - * [isHttpResponseClientError][FunctionDeclaration-31] - * [isHttpResponseBadRequest][FunctionDeclaration-32] - * [isHttpResponseUnauthorized][FunctionDeclaration-33] - * [isHttpResponseForbidden][FunctionDeclaration-34] - * [isHttpResponseNotFound][FunctionDeclaration-35] - * [isHttpResponseMethodNotAllowed][FunctionDeclaration-36] - * [isHttpResponseConflict][FunctionDeclaration-37] - * [isHttpResponseServerError][FunctionDeclaration-38] - * [isHttpResponseInternalServerError][FunctionDeclaration-39] - * [isHttpResponseNotImplemented][FunctionDeclaration-40] - * [Hook][FunctionDeclaration-41] - * [getHookFunction][FunctionDeclaration-42] - * [makeControllerRoutes][FunctionDeclaration-43] - * [getPath][FunctionDeclaration-44] - * [getHttpMethod][FunctionDeclaration-45] - * [createController][FunctionDeclaration-46] - * [createService][FunctionDeclaration-47] - * [dependency][FunctionDeclaration-48] - * [createApp][FunctionDeclaration-49] + * [logIn][FunctionDeclaration-5] + * [logOut][FunctionDeclaration-6] + * [isObjectDoesNotExist][FunctionDeclaration-7] + * [isPermissionDenied][FunctionDeclaration-8] + * [isValidationError][FunctionDeclaration-9] + * [Log][FunctionDeclaration-10] + * [ValidateBody][FunctionDeclaration-11] + * [ValidateHeaders][FunctionDeclaration-12] + * [ValidateParams][FunctionDeclaration-13] + * [ValidateQuery][FunctionDeclaration-14] + * [middleware][FunctionDeclaration-15] + * [controller][FunctionDeclaration-16] + * [escapeProp][FunctionDeclaration-17] + * [escape][FunctionDeclaration-18] + * [getAjvInstance][FunctionDeclaration-19] + * [render][FunctionDeclaration-20] + * [validate][FunctionDeclaration-21] + * [Get][FunctionDeclaration-22] + * [Post][FunctionDeclaration-23] + * [Put][FunctionDeclaration-24] + * [Patch][FunctionDeclaration-25] + * [Delete][FunctionDeclaration-26] + * [isHttpResponse][FunctionDeclaration-27] + * [isHttpResponseSuccess][FunctionDeclaration-28] + * [isHttpResponseOK][FunctionDeclaration-29] + * [isHttpResponseCreated][FunctionDeclaration-30] + * [isHttpResponseNoContent][FunctionDeclaration-31] + * [isHttpResponseRedirection][FunctionDeclaration-32] + * [isHttpResponseRedirect][FunctionDeclaration-33] + * [isHttpResponseClientError][FunctionDeclaration-34] + * [isHttpResponseBadRequest][FunctionDeclaration-35] + * [isHttpResponseUnauthorized][FunctionDeclaration-36] + * [isHttpResponseForbidden][FunctionDeclaration-37] + * [isHttpResponseNotFound][FunctionDeclaration-38] + * [isHttpResponseMethodNotAllowed][FunctionDeclaration-39] + * [isHttpResponseConflict][FunctionDeclaration-40] + * [isHttpResponseServerError][FunctionDeclaration-41] + * [isHttpResponseInternalServerError][FunctionDeclaration-42] + * [isHttpResponseNotImplemented][FunctionDeclaration-43] + * [Hook][FunctionDeclaration-44] + * [getHookFunction][FunctionDeclaration-45] + * [makeControllerRoutes][FunctionDeclaration-46] + * [getPath][FunctionDeclaration-47] + * [getHttpMethod][FunctionDeclaration-48] + * [createController][FunctionDeclaration-49] + * [createService][FunctionDeclaration-50] + * [dependency][FunctionDeclaration-51] + * [createApp][FunctionDeclaration-52] * Interfaces + * [EmailUser][InterfaceDeclaration-0] * [IAuthenticator][InterfaceDeclaration-2] * [Strategy][InterfaceDeclaration-3] - * [IResourceCollection][InterfaceDeclaration-4] - * [CollectionParams][InterfaceDeclaration-5] + * [LogOptions][InterfaceDeclaration-7] + * [IResourceCollection][InterfaceDeclaration-5] + * [CollectionParams][InterfaceDeclaration-6] * [Class][InterfaceDeclaration-1] - * [Route][InterfaceDeclaration-6] - * [CreateAppOptions][InterfaceDeclaration-7] + * [CookieOptions][InterfaceDeclaration-4] + * [Route][InterfaceDeclaration-8] + * [CreateAppOptions][InterfaceDeclaration-9] * Types * [Middleware][TypeAliasDeclaration-1] + * [RelationLoader][TypeAliasDeclaration-2] * [HttpMethod][TypeAliasDeclaration-3] * [HookFunction][TypeAliasDeclaration-4] * [HookDecorator][TypeAliasDeclaration-0] @@ -165,6 +172,43 @@ function LoginRequired(options: { redirect?: string | undefined; } = {}): HookDe ---------- +### logIn + +```typescript +function logIn(ctx: Context, user: AbstractUser): void; +``` + +**Parameters** + +| Name | Type | +| ---- | ----------------------------------------------------------------- | +| ctx | [Context][ClassDeclaration-6]<[AbstractUser][ClassDeclaration-1]> | +| user | [AbstractUser][ClassDeclaration-1] | + +**Return type** + +void + +---------- + +### logOut + +```typescript +function logOut(ctx: Context): void; +``` + +**Parameters** + +| Name | Type | +| ---- | ----------------------------------------------------------------- | +| ctx | [Context][ClassDeclaration-6]<[AbstractUser][ClassDeclaration-1]> | + +**Return type** + +void + +---------- + ### isObjectDoesNotExist ```typescript @@ -221,16 +265,18 @@ err is [ValidationError][ClassDeclaration-25] ### Log +Logs a message with optional information on the HTTP request. + ```typescript -function Log(message: string, logFn: { (message?: any, ...optionalParams: any[]): void; (message?: any, ...optionalParams: any[]): voi... = console.log): HookDecorator; +function Log(message: string, options: LogOptions = {}): HookDecorator; ``` **Parameters** -| Name | Type | Default value | -| ------- | ---------------------------------------------------------------------------------------------------- | ------------- | -| message | string | | -| logFn | { (message?: any, ...optionalParams: any[]): void; (message?: any, ...optionalParams: any[]): voi... | console.log | +| Name | Type | Default value | Description | +| ------- | ------------------------------------ | ------------- | --------------------------------------------------------------------------- | +| message | string | | The message to print. | +| options | [LogOptions][InterfaceDeclaration-7] | {} | Options to specify which information on the HTTP request should be printed. | **Return type** @@ -333,7 +379,7 @@ function middleware(operations: string, middleware: Middleware): Partial> +Partial> ---------- @@ -393,6 +439,18 @@ string ---------- +### getAjvInstance + +```typescript +function getAjvInstance(): Ajv; +``` + +**Return type** + +Ajv + +---------- + ### render ```typescript @@ -881,7 +939,7 @@ function makeControllerRoutes(parentPath: string, parentHooks: HookFunction[], c **Return type** -[Route][InterfaceDeclaration-6][] +[Route][InterfaceDeclaration-8][] ---------- @@ -1007,7 +1065,7 @@ function createApp(rootControllerClass: Class, options: CreateAppOptions = | Name | Type | Default value | | ------------------- | ------------------------------------------ | ------------- | | rootControllerClass | [Class][InterfaceDeclaration-1] | | -| options | [CreateAppOptions][InterfaceDeclaration-7] | {} | +| options | [CreateAppOptions][InterfaceDeclaration-9] | {} | **Return type** @@ -1015,6 +1073,28 @@ any ## Interfaces +### EmailUser + +```typescript +interface EmailUser extends AbstractUser { + email: string; + password: string; +} +``` + +**Extends** + +[AbstractUser][ClassDeclaration-1] + +**Properties** + +| Name | Type | Optional | +| -------- | ------ | -------- | +| email | string | false | +| password | string | false | + +---------- + ### IAuthenticator ```typescript @@ -1067,6 +1147,30 @@ interface Strategy { ---------- +### LogOptions + +```typescript +interface LogOptions { + body?: boolean | undefined; + params?: boolean | undefined; + headers?: string[] | boolean; + query?: boolean | undefined; + logFn?: typeof ???; +} +``` + +**Properties** + +| Name | Type | Optional | +| ------- | ------------------------ | -------- | +| body | boolean | undefined | true | +| params | boolean | undefined | true | +| headers | string[] | boolean | true | +| query | boolean | undefined | true | +| logFn | typeof ??? | true | + +---------- + ### IResourceCollection Service interface. Create, read, update or delete resources and return representations of them. @@ -1231,6 +1335,34 @@ new (args: any[]): T; T +---------- + +### CookieOptions + +```typescript +interface CookieOptions { + domain?: string | undefined; + expires?: Date | undefined; + httpOnly?: boolean | undefined; + maxAge?: number | undefined; + path?: string | undefined; + secure?: boolean | undefined; + sameSite?: "strict" | "lax"; +} +``` + +**Properties** + +| Name | Type | Optional | +| -------- | ------------------------ | -------- | +| domain | string | undefined | true | +| expires | Date | undefined | true | +| httpOnly | boolean | undefined | true | +| maxAge | number | undefined | true | +| path | string | undefined | true | +| secure | boolean | undefined | true | +| sameSite | "strict" | "lax" | true | + ---------- ### Route @@ -1295,6 +1427,18 @@ type Middleware = (context: { user: AbstractUser | undefined; resource: any; dat ---------- +### RelationLoader + +```typescript +type RelationLoader = (user: AbstractUser | undefined, params: CollectionParams) => string[]; +``` + +**Type** + +(user: AbstractUser | undefined, params: CollectionParams) => string[] + +---------- + ### HttpMethod ```typescript @@ -1513,98 +1657,109 @@ const emailSchema: { additionalProperties: boolean; properties: { email: { type: [TypeAliasDeclaration-0]: index.md#hookdecorator [FunctionDeclaration-4]: index.md#loginrequired [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-5]: index.md#isobjectdoesnotexist +[FunctionDeclaration-5]: index.md#login +[ClassDeclaration-1]: index/abstractuser.md#abstractuser +[ClassDeclaration-6]: index/context.md#context +[ClassDeclaration-1]: index/abstractuser.md#abstractuser +[FunctionDeclaration-6]: index.md#logout +[ClassDeclaration-1]: index/abstractuser.md#abstractuser +[ClassDeclaration-6]: index/context.md#context +[FunctionDeclaration-7]: index.md#isobjectdoesnotexist [ClassDeclaration-23]: index/objectdoesnotexist.md#objectdoesnotexist -[FunctionDeclaration-6]: index.md#ispermissiondenied +[FunctionDeclaration-8]: index.md#ispermissiondenied [ClassDeclaration-24]: index/permissiondenied.md#permissiondenied -[FunctionDeclaration-7]: index.md#isvalidationerror +[FunctionDeclaration-9]: index.md#isvalidationerror [ClassDeclaration-25]: index/validationerror.md#validationerror -[FunctionDeclaration-8]: index.md#log +[FunctionDeclaration-10]: index.md#log +[InterfaceDeclaration-7]: index.md#logoptions [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-9]: index.md#validatebody +[FunctionDeclaration-11]: index.md#validatebody [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-10]: index.md#validateheaders +[FunctionDeclaration-12]: index.md#validateheaders [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-11]: index.md#validateparams +[FunctionDeclaration-13]: index.md#validateparams [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-12]: index.md#validatequery +[FunctionDeclaration-14]: index.md#validatequery [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-13]: index.md#middleware +[FunctionDeclaration-15]: index.md#middleware [TypeAliasDeclaration-1]: index.md#middleware -[InterfaceDeclaration-4]: index.md#iresourcecollection +[InterfaceDeclaration-5]: index.md#iresourcecollection [TypeAliasDeclaration-1]: index.md#middleware -[FunctionDeclaration-14]: index.md#controller +[FunctionDeclaration-16]: index.md#controller [InterfaceDeclaration-1]: index.md#class [InterfaceDeclaration-1]: index.md#class -[FunctionDeclaration-15]: index.md#escapeprop -[FunctionDeclaration-16]: index.md#escape -[FunctionDeclaration-17]: index.md#render +[FunctionDeclaration-17]: index.md#escapeprop +[FunctionDeclaration-18]: index.md#escape +[FunctionDeclaration-19]: index.md#getajvinstance +[FunctionDeclaration-20]: index.md#render [ClassDeclaration-20]: index/httpresponseok.md#httpresponseok -[FunctionDeclaration-18]: index.md#validate -[FunctionDeclaration-19]: index.md#get -[FunctionDeclaration-20]: index.md#post -[FunctionDeclaration-21]: index.md#put -[FunctionDeclaration-22]: index.md#patch -[FunctionDeclaration-23]: index.md#delete -[FunctionDeclaration-24]: index.md#ishttpresponse +[FunctionDeclaration-21]: index.md#validate +[FunctionDeclaration-22]: index.md#get +[FunctionDeclaration-23]: index.md#post +[FunctionDeclaration-24]: index.md#put +[FunctionDeclaration-25]: index.md#patch +[FunctionDeclaration-26]: index.md#delete +[FunctionDeclaration-27]: index.md#ishttpresponse [ClassDeclaration-9]: index/httpresponse.md#httpresponse -[FunctionDeclaration-25]: index.md#ishttpresponsesuccess +[FunctionDeclaration-28]: index.md#ishttpresponsesuccess [ClassDeclaration-11]: index/httpresponsesuccess.md#httpresponsesuccess -[FunctionDeclaration-26]: index.md#ishttpresponseok +[FunctionDeclaration-29]: index.md#ishttpresponseok [ClassDeclaration-20]: index/httpresponseok.md#httpresponseok -[FunctionDeclaration-27]: index.md#ishttpresponsecreated +[FunctionDeclaration-30]: index.md#ishttpresponsecreated [ClassDeclaration-22]: index/httpresponsecreated.md#httpresponsecreated -[FunctionDeclaration-28]: index.md#ishttpresponsenocontent +[FunctionDeclaration-31]: index.md#ishttpresponsenocontent [ClassDeclaration-10]: index/httpresponsenocontent.md#httpresponsenocontent -[FunctionDeclaration-29]: index.md#ishttpresponseredirection +[FunctionDeclaration-32]: index.md#ishttpresponseredirection [ClassDeclaration-8]: index/httpresponseredirection.md#httpresponseredirection -[FunctionDeclaration-30]: index.md#ishttpresponseredirect +[FunctionDeclaration-33]: index.md#ishttpresponseredirect [ClassDeclaration-7]: index/httpresponseredirect.md#httpresponseredirect -[FunctionDeclaration-31]: index.md#ishttpresponseclienterror +[FunctionDeclaration-34]: index.md#ishttpresponseclienterror [ClassDeclaration-13]: index/httpresponseclienterror.md#httpresponseclienterror -[FunctionDeclaration-32]: index.md#ishttpresponsebadrequest +[FunctionDeclaration-35]: index.md#ishttpresponsebadrequest [ClassDeclaration-14]: index/httpresponsebadrequest.md#httpresponsebadrequest -[FunctionDeclaration-33]: index.md#ishttpresponseunauthorized +[FunctionDeclaration-36]: index.md#ishttpresponseunauthorized [ClassDeclaration-15]: index/httpresponseunauthorized.md#httpresponseunauthorized -[FunctionDeclaration-34]: index.md#ishttpresponseforbidden +[FunctionDeclaration-37]: index.md#ishttpresponseforbidden [ClassDeclaration-21]: index/httpresponseforbidden.md#httpresponseforbidden -[FunctionDeclaration-35]: index.md#ishttpresponsenotfound +[FunctionDeclaration-38]: index.md#ishttpresponsenotfound [ClassDeclaration-12]: index/httpresponsenotfound.md#httpresponsenotfound -[FunctionDeclaration-36]: index.md#ishttpresponsemethodnotallowed +[FunctionDeclaration-39]: index.md#ishttpresponsemethodnotallowed [ClassDeclaration-17]: index/httpresponsemethodnotallowed.md#httpresponsemethodnotallowed -[FunctionDeclaration-37]: index.md#ishttpresponseconflict +[FunctionDeclaration-40]: index.md#ishttpresponseconflict [ClassDeclaration-27]: index/httpresponseconflict.md#httpresponseconflict -[FunctionDeclaration-38]: index.md#ishttpresponseservererror +[FunctionDeclaration-41]: index.md#ishttpresponseservererror [ClassDeclaration-19]: index/httpresponseservererror.md#httpresponseservererror -[FunctionDeclaration-39]: index.md#ishttpresponseinternalservererror +[FunctionDeclaration-42]: index.md#ishttpresponseinternalservererror [ClassDeclaration-28]: index/httpresponseinternalservererror.md#httpresponseinternalservererror -[FunctionDeclaration-40]: index.md#ishttpresponsenotimplemented +[FunctionDeclaration-43]: index.md#ishttpresponsenotimplemented [ClassDeclaration-18]: index/httpresponsenotimplemented.md#httpresponsenotimplemented -[FunctionDeclaration-41]: index.md#hook +[FunctionDeclaration-44]: index.md#hook [TypeAliasDeclaration-4]: index.md#hookfunction [TypeAliasDeclaration-0]: index.md#hookdecorator -[FunctionDeclaration-42]: index.md#gethookfunction +[FunctionDeclaration-45]: index.md#gethookfunction [TypeAliasDeclaration-0]: index.md#hookdecorator [TypeAliasDeclaration-4]: index.md#hookfunction -[FunctionDeclaration-43]: index.md#makecontrollerroutes +[FunctionDeclaration-46]: index.md#makecontrollerroutes [TypeAliasDeclaration-4]: index.md#hookfunction [InterfaceDeclaration-1]: index.md#class [ClassDeclaration-5]: index/servicemanager.md#servicemanager -[InterfaceDeclaration-6]: index.md#route -[FunctionDeclaration-44]: index.md#getpath +[InterfaceDeclaration-8]: index.md#route +[FunctionDeclaration-47]: index.md#getpath [InterfaceDeclaration-1]: index.md#class -[FunctionDeclaration-45]: index.md#gethttpmethod +[FunctionDeclaration-48]: index.md#gethttpmethod [InterfaceDeclaration-1]: index.md#class -[FunctionDeclaration-46]: index.md#createcontroller +[FunctionDeclaration-49]: index.md#createcontroller [InterfaceDeclaration-1]: index.md#class [ClassDeclaration-5]: index/servicemanager.md#servicemanager -[FunctionDeclaration-47]: index.md#createservice +[FunctionDeclaration-50]: index.md#createservice [InterfaceDeclaration-1]: index.md#class [ClassDeclaration-5]: index/servicemanager.md#servicemanager -[FunctionDeclaration-48]: index.md#dependency -[FunctionDeclaration-49]: index.md#createapp +[FunctionDeclaration-51]: index.md#dependency +[FunctionDeclaration-52]: index.md#createapp [InterfaceDeclaration-1]: index.md#class -[InterfaceDeclaration-7]: index.md#createappoptions +[InterfaceDeclaration-9]: index.md#createappoptions +[InterfaceDeclaration-0]: index.md#emailuser +[ClassDeclaration-1]: index/abstractuser.md#abstractuser [InterfaceDeclaration-2]: index.md#iauthenticator [ClassDeclaration-1]: index/abstractuser.md#abstractuser [ClassDeclaration-1]: index/abstractuser.md#abstractuser @@ -1612,20 +1767,23 @@ const emailSchema: { additionalProperties: boolean; properties: { email: { type: [ClassDeclaration-1]: index/abstractuser.md#abstractuser [InterfaceDeclaration-2]: index.md#iauthenticator [InterfaceDeclaration-1]: index.md#class -[InterfaceDeclaration-4]: index.md#iresourcecollection +[InterfaceDeclaration-7]: index.md#logoptions +[InterfaceDeclaration-5]: index.md#iresourcecollection [ClassDeclaration-1]: index/abstractuser.md#abstractuser [ClassDeclaration-1]: index/abstractuser.md#abstractuser [ClassDeclaration-1]: index/abstractuser.md#abstractuser [ClassDeclaration-1]: index/abstractuser.md#abstractuser [ClassDeclaration-1]: index/abstractuser.md#abstractuser [ClassDeclaration-1]: index/abstractuser.md#abstractuser -[InterfaceDeclaration-5]: index.md#collectionparams +[InterfaceDeclaration-6]: index.md#collectionparams [InterfaceDeclaration-1]: index.md#class -[InterfaceDeclaration-6]: index.md#route +[InterfaceDeclaration-4]: index.md#cookieoptions +[InterfaceDeclaration-8]: index.md#route [TypeAliasDeclaration-3]: index.md#httpmethod [TypeAliasDeclaration-4]: index.md#hookfunction -[InterfaceDeclaration-7]: index.md#createappoptions +[InterfaceDeclaration-9]: index.md#createappoptions [TypeAliasDeclaration-1]: index.md#middleware +[TypeAliasDeclaration-2]: index.md#relationloader [TypeAliasDeclaration-3]: index.md#httpmethod [TypeAliasDeclaration-4]: index.md#hookfunction [TypeAliasDeclaration-0]: index.md#hookdecorator diff --git a/docs/api/index/config.md b/docs/api/index/config.md index 09daec6ca3..fbc9109559 100644 --- a/docs/api/index/config.md +++ b/docs/api/index/config.md @@ -2,9 +2,9 @@ * [Config][ClassDeclaration-29] * Methods - * [get(configName, propName, defaultValue)][MethodDeclaration-24] + * [get(configName, propName, defaultValue)][MethodDeclaration-30] * Properties - * [root][PropertyDeclaration-71] + * [root][PropertyDeclaration-69] # Config @@ -44,5 +44,5 @@ public static root: string; string [ClassDeclaration-29]: config.md#config -[MethodDeclaration-24]: config.md#getconfigname-propname-defaultvalue -[PropertyDeclaration-71]: config.md#root \ No newline at end of file +[MethodDeclaration-30]: config.md#getconfigname-propname-defaultvalue +[PropertyDeclaration-69]: config.md#root \ No newline at end of file diff --git a/docs/api/index/emailauthenticator.md b/docs/api/index/emailauthenticator.md index e82fd53559..6ec31afc78 100644 --- a/docs/api/index/emailauthenticator.md +++ b/docs/api/index/emailauthenticator.md @@ -19,7 +19,7 @@ abstract class EmailAuthenticator implements IAuthentica | Name | Constraint | | ---- | ----------------------------------- | -| User | EmailUser | +| User | [EmailUser][InterfaceDeclaration-0] | ## Methods ### checkPassword(user, password) @@ -70,6 +70,7 @@ public abstract entityClass: Class; [Class][InterfaceDeclaration-1] [ClassDeclaration-0]: emailauthenticator.md#emailauthenticator +[InterfaceDeclaration-0]: ../index.md#emailuser [MethodDeclaration-1]: emailauthenticator.md#checkpassworduser-password [MethodDeclaration-2]: emailauthenticator.md#authenticate__0 [PropertyDeclaration-0]: emailauthenticator.md#entityclass diff --git a/docs/api/index/entityresourcecollection.md b/docs/api/index/entityresourcecollection.md index 7457a585bf..9016e76cf8 100644 --- a/docs/api/index/entityresourcecollection.md +++ b/docs/api/index/entityresourcecollection.md @@ -2,18 +2,18 @@ * [EntityResourceCollection][ClassDeclaration-26] * Methods - * [create(user, data, params)][MethodDeclaration-18] - * [findById(user, id, params)][MethodDeclaration-19] - * [find(user, params)][MethodDeclaration-20] - * [modifyById(user, id, data, params)][MethodDeclaration-21] - * [updateById(user, id, data, params)][MethodDeclaration-22] - * [deleteById(user, id, params)][MethodDeclaration-23] + * [create(user, data, params)][MethodDeclaration-24] + * [findById(user, id, params)][MethodDeclaration-25] + * [find(user, params)][MethodDeclaration-26] + * [modifyById(user, id, data, params)][MethodDeclaration-27] + * [updateById(user, id, data, params)][MethodDeclaration-28] + * [deleteById(user, id, params)][MethodDeclaration-29] * Properties - * [entityClass][PropertyDeclaration-60] - * [allowedOperations][PropertyDeclaration-61] - * [middlewares][PropertyDeclaration-62] - * [loadedRelations][PropertyDeclaration-63] - * [connectionName][PropertyDeclaration-64] + * [entityClass][PropertyDeclaration-58] + * [allowedOperations][PropertyDeclaration-59] + * [middlewares][PropertyDeclaration-60] + * [loadedRelations][PropertyDeclaration-61] + * [connectionName][PropertyDeclaration-62] # EntityResourceCollection @@ -166,7 +166,7 @@ public abstract readonly allowedOperations: (keyof IResourceCollection)[]; **Type** -(keyof [IResourceCollection][InterfaceDeclaration-4])[] +(keyof [IResourceCollection][InterfaceDeclaration-5])[] ---------- @@ -178,7 +178,7 @@ public readonly middlewares: Partial>[] +Partial>[] ---------- @@ -190,7 +190,7 @@ public readonly loadedRelations: Partial> +Partial> ---------- @@ -205,24 +205,25 @@ public readonly connectionName: string; string [ClassDeclaration-26]: entityresourcecollection.md#entityresourcecollection -[MethodDeclaration-18]: entityresourcecollection.md#createuser-data-params +[MethodDeclaration-24]: entityresourcecollection.md#createuser-data-params [ClassDeclaration-1]: abstractuser.md#abstractuser -[MethodDeclaration-19]: entityresourcecollection.md#findbyiduser-id-params +[MethodDeclaration-25]: entityresourcecollection.md#findbyiduser-id-params [ClassDeclaration-1]: abstractuser.md#abstractuser -[MethodDeclaration-20]: entityresourcecollection.md#finduser-params +[MethodDeclaration-26]: entityresourcecollection.md#finduser-params [ClassDeclaration-1]: abstractuser.md#abstractuser -[MethodDeclaration-21]: entityresourcecollection.md#modifybyiduser-id-data-params +[MethodDeclaration-27]: entityresourcecollection.md#modifybyiduser-id-data-params [ClassDeclaration-1]: abstractuser.md#abstractuser -[MethodDeclaration-22]: entityresourcecollection.md#updatebyiduser-id-data-params +[MethodDeclaration-28]: entityresourcecollection.md#updatebyiduser-id-data-params [ClassDeclaration-1]: abstractuser.md#abstractuser -[MethodDeclaration-23]: entityresourcecollection.md#deletebyiduser-id-params +[MethodDeclaration-29]: entityresourcecollection.md#deletebyiduser-id-params [ClassDeclaration-1]: abstractuser.md#abstractuser -[PropertyDeclaration-60]: entityresourcecollection.md#entityclass +[PropertyDeclaration-58]: entityresourcecollection.md#entityclass [InterfaceDeclaration-1]: ../index.md#class -[PropertyDeclaration-61]: entityresourcecollection.md#allowedoperations -[InterfaceDeclaration-4]: ../index.md#iresourcecollection -[PropertyDeclaration-62]: entityresourcecollection.md#middlewares -[InterfaceDeclaration-4]: ../index.md#iresourcecollection +[PropertyDeclaration-59]: entityresourcecollection.md#allowedoperations +[InterfaceDeclaration-5]: ../index.md#iresourcecollection +[PropertyDeclaration-60]: entityresourcecollection.md#middlewares +[InterfaceDeclaration-5]: ../index.md#iresourcecollection [TypeAliasDeclaration-1]: ../index.md#middleware -[PropertyDeclaration-63]: entityresourcecollection.md#loadedrelations -[PropertyDeclaration-64]: entityresourcecollection.md#connectionname \ No newline at end of file +[PropertyDeclaration-61]: entityresourcecollection.md#loadedrelations +[TypeAliasDeclaration-2]: ../index.md#relationloader +[PropertyDeclaration-62]: entityresourcecollection.md#connectionname \ No newline at end of file diff --git a/docs/api/index/httpresponse.md b/docs/api/index/httpresponse.md index 308d319558..42b722ff1a 100644 --- a/docs/api/index/httpresponse.md +++ b/docs/api/index/httpresponse.md @@ -2,12 +2,18 @@ * [HttpResponse][ClassDeclaration-9] * Constructor - * [constructor(content)][Constructor-3] + * [constructor(body)][Constructor-3] + * Methods + * [setHeader(name, value)][MethodDeclaration-6] + * [getHeader(name)][MethodDeclaration-7] + * [getHeaders()][MethodDeclaration-8] + * [setCookie(name, value, options)][MethodDeclaration-9] + * [getCookie(name)][MethodDeclaration-10] + * [getCookies()][MethodDeclaration-11] * Properties * [isHttpResponse][PropertyDeclaration-21] - * [headers][PropertyDeclaration-22] - * [statusCode][PropertyDeclaration-23] - * [statusMessage][PropertyDeclaration-24] + * [statusCode][PropertyDeclaration-22] + * [statusMessage][PropertyDeclaration-23] # HttpResponse @@ -16,44 +22,131 @@ abstract class HttpResponse ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | -## Properties +## Methods -### isHttpResponse +### setHeader(name, value) ```typescript -public readonly isHttpResponse: true; +public setHeader(name: string, value: string): void; ``` -**Type** +**Parameters** -true +| Name | Type | +| ----- | ------ | +| name | string | +| value | string | + +**Return type** + +void ---------- -### headers +### getHeader(name) ```typescript -public headers: { [key: string]: string; }; +public getHeader(name: string): string | undefined; ``` -**Type** +**Parameters** + +| Name | Type | +| ---- | ------ | +| name | string | + +**Return type** + +string | undefined + +---------- + +### getHeaders() + +```typescript +public getHeaders(): { [key: string]: string; }; +``` + +**Return type** { [key: string]: string; } ---------- +### setCookie(name, value, options) + +```typescript +public setCookie(name: string, value: string, options: CookieOptions = {}): void; +``` + +**Parameters** + +| Name | Type | Default value | +| ------- | --------------------------------------- | ------------- | +| name | string | | +| value | string | | +| options | [CookieOptions][InterfaceDeclaration-4] | {} | + +**Return type** + +void + +---------- + +### getCookie(name) + +```typescript +public getCookie(name: string): { value: string | undefined; options: CookieOptions; }; +``` + +**Parameters** + +| Name | Type | +| ---- | ------ | +| name | string | + +**Return type** + +{ value: string | undefined; options: [CookieOptions][InterfaceDeclaration-4]; } + +---------- + +### getCookies() + +```typescript +public getCookies(): { [key: string]: { value: string | undefined; options: CookieOptions; }; }; +``` + +**Return type** + +{ [key: string]: { value: string | undefined; options: [CookieOptions][InterfaceDeclaration-4]; }; } + +## Properties + +### isHttpResponse + +```typescript +public readonly isHttpResponse: true; +``` + +**Type** + +true + +---------- + ### statusCode ```typescript @@ -77,8 +170,16 @@ public abstract statusMessage: string; string [ClassDeclaration-9]: httpresponse.md#httpresponse -[Constructor-3]: httpresponse.md#constructorcontent +[Constructor-3]: httpresponse.md#constructorbody +[MethodDeclaration-6]: httpresponse.md#setheadername-value +[MethodDeclaration-7]: httpresponse.md#getheadername +[MethodDeclaration-8]: httpresponse.md#getheaders +[MethodDeclaration-9]: httpresponse.md#setcookiename-value-options +[InterfaceDeclaration-4]: ../index.md#cookieoptions +[MethodDeclaration-10]: httpresponse.md#getcookiename +[InterfaceDeclaration-4]: ../index.md#cookieoptions +[MethodDeclaration-11]: httpresponse.md#getcookies +[InterfaceDeclaration-4]: ../index.md#cookieoptions [PropertyDeclaration-21]: httpresponse.md#ishttpresponse -[PropertyDeclaration-22]: httpresponse.md#headers -[PropertyDeclaration-23]: httpresponse.md#statuscode -[PropertyDeclaration-24]: httpresponse.md#statusmessage \ No newline at end of file +[PropertyDeclaration-22]: httpresponse.md#statuscode +[PropertyDeclaration-23]: httpresponse.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponsebadrequest.md b/docs/api/index/httpresponsebadrequest.md index 461a2c1e52..e24af52180 100644 --- a/docs/api/index/httpresponsebadrequest.md +++ b/docs/api/index/httpresponsebadrequest.md @@ -2,11 +2,11 @@ * [HttpResponseBadRequest][ClassDeclaration-14] * Constructor - * [constructor(content)][Constructor-8] + * [constructor(body)][Constructor-8] * Properties - * [isHttpResponseBadRequest][PropertyDeclaration-33] - * [statusCode][PropertyDeclaration-34] - * [statusMessage][PropertyDeclaration-35] + * [isHttpResponseBadRequest][PropertyDeclaration-32] + * [statusCode][PropertyDeclaration-33] + * [statusMessage][PropertyDeclaration-34] # HttpResponseBadRequest @@ -15,17 +15,17 @@ class HttpResponseBadRequest ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-14]: httpresponsebadrequest.md#httpresponsebadrequest -[Constructor-8]: httpresponsebadrequest.md#constructorcontent -[PropertyDeclaration-33]: httpresponsebadrequest.md#ishttpresponsebadrequest -[PropertyDeclaration-34]: httpresponsebadrequest.md#statuscode -[PropertyDeclaration-35]: httpresponsebadrequest.md#statusmessage \ No newline at end of file +[Constructor-8]: httpresponsebadrequest.md#constructorbody +[PropertyDeclaration-32]: httpresponsebadrequest.md#ishttpresponsebadrequest +[PropertyDeclaration-33]: httpresponsebadrequest.md#statuscode +[PropertyDeclaration-34]: httpresponsebadrequest.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponseclienterror.md b/docs/api/index/httpresponseclienterror.md index aaf02ac02d..0c8e75cbf0 100644 --- a/docs/api/index/httpresponseclienterror.md +++ b/docs/api/index/httpresponseclienterror.md @@ -2,9 +2,9 @@ * [HttpResponseClientError][ClassDeclaration-13] * Constructor - * [constructor(content)][Constructor-7] + * [constructor(body)][Constructor-7] * Properties - * [isHttpResponseClientError][PropertyDeclaration-32] + * [isHttpResponseClientError][PropertyDeclaration-31] # HttpResponseClientError @@ -13,17 +13,17 @@ abstract class HttpResponseClientError ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -38,5 +38,5 @@ public readonly isHttpResponseClientError: true; true [ClassDeclaration-13]: httpresponseclienterror.md#httpresponseclienterror -[Constructor-7]: httpresponseclienterror.md#constructorcontent -[PropertyDeclaration-32]: httpresponseclienterror.md#ishttpresponseclienterror \ No newline at end of file +[Constructor-7]: httpresponseclienterror.md#constructorbody +[PropertyDeclaration-31]: httpresponseclienterror.md#ishttpresponseclienterror \ No newline at end of file diff --git a/docs/api/index/httpresponseconflict.md b/docs/api/index/httpresponseconflict.md index cfe29e0ac6..191d69de1b 100644 --- a/docs/api/index/httpresponseconflict.md +++ b/docs/api/index/httpresponseconflict.md @@ -2,11 +2,11 @@ * [HttpResponseConflict][ClassDeclaration-27] * Constructor - * [constructor(content)][Constructor-19] + * [constructor(body)][Constructor-19] * Properties - * [isHttpResponseConflict][PropertyDeclaration-65] - * [statusCode][PropertyDeclaration-66] - * [statusMessage][PropertyDeclaration-67] + * [isHttpResponseConflict][PropertyDeclaration-63] + * [statusCode][PropertyDeclaration-64] + * [statusMessage][PropertyDeclaration-65] # HttpResponseConflict @@ -15,17 +15,17 @@ class HttpResponseConflict ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-27]: httpresponseconflict.md#httpresponseconflict -[Constructor-19]: httpresponseconflict.md#constructorcontent -[PropertyDeclaration-65]: httpresponseconflict.md#ishttpresponseconflict -[PropertyDeclaration-66]: httpresponseconflict.md#statuscode -[PropertyDeclaration-67]: httpresponseconflict.md#statusmessage \ No newline at end of file +[Constructor-19]: httpresponseconflict.md#constructorbody +[PropertyDeclaration-63]: httpresponseconflict.md#ishttpresponseconflict +[PropertyDeclaration-64]: httpresponseconflict.md#statuscode +[PropertyDeclaration-65]: httpresponseconflict.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponsecreated.md b/docs/api/index/httpresponsecreated.md index 50e22ab3bb..aee744647c 100644 --- a/docs/api/index/httpresponsecreated.md +++ b/docs/api/index/httpresponsecreated.md @@ -2,11 +2,11 @@ * [HttpResponseCreated][ClassDeclaration-22] * Constructor - * [constructor(content)][Constructor-15] + * [constructor(body)][Constructor-15] * Properties - * [isHttpResponseCreated][PropertyDeclaration-54] - * [statusCode][PropertyDeclaration-55] - * [statusMessage][PropertyDeclaration-56] + * [isHttpResponseCreated][PropertyDeclaration-52] + * [statusCode][PropertyDeclaration-53] + * [statusMessage][PropertyDeclaration-54] # HttpResponseCreated @@ -15,17 +15,17 @@ class HttpResponseCreated ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-22]: httpresponsecreated.md#httpresponsecreated -[Constructor-15]: httpresponsecreated.md#constructorcontent -[PropertyDeclaration-54]: httpresponsecreated.md#ishttpresponsecreated -[PropertyDeclaration-55]: httpresponsecreated.md#statuscode -[PropertyDeclaration-56]: httpresponsecreated.md#statusmessage \ No newline at end of file +[Constructor-15]: httpresponsecreated.md#constructorbody +[PropertyDeclaration-52]: httpresponsecreated.md#ishttpresponsecreated +[PropertyDeclaration-53]: httpresponsecreated.md#statuscode +[PropertyDeclaration-54]: httpresponsecreated.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponseforbidden.md b/docs/api/index/httpresponseforbidden.md index 4eba35bd88..fd7f4505c7 100644 --- a/docs/api/index/httpresponseforbidden.md +++ b/docs/api/index/httpresponseforbidden.md @@ -2,11 +2,11 @@ * [HttpResponseForbidden][ClassDeclaration-21] * Constructor - * [constructor(content)][Constructor-14] + * [constructor(body)][Constructor-14] * Properties - * [isHttpResponseForbidden][PropertyDeclaration-51] - * [statusCode][PropertyDeclaration-52] - * [statusMessage][PropertyDeclaration-53] + * [isHttpResponseForbidden][PropertyDeclaration-49] + * [statusCode][PropertyDeclaration-50] + * [statusMessage][PropertyDeclaration-51] # HttpResponseForbidden @@ -15,17 +15,17 @@ class HttpResponseForbidden ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden -[Constructor-14]: httpresponseforbidden.md#constructorcontent -[PropertyDeclaration-51]: httpresponseforbidden.md#ishttpresponseforbidden -[PropertyDeclaration-52]: httpresponseforbidden.md#statuscode -[PropertyDeclaration-53]: httpresponseforbidden.md#statusmessage \ No newline at end of file +[Constructor-14]: httpresponseforbidden.md#constructorbody +[PropertyDeclaration-49]: httpresponseforbidden.md#ishttpresponseforbidden +[PropertyDeclaration-50]: httpresponseforbidden.md#statuscode +[PropertyDeclaration-51]: httpresponseforbidden.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponseinternalservererror.md b/docs/api/index/httpresponseinternalservererror.md index e3eb5fa018..91110b7afb 100644 --- a/docs/api/index/httpresponseinternalservererror.md +++ b/docs/api/index/httpresponseinternalservererror.md @@ -2,11 +2,11 @@ * [HttpResponseInternalServerError][ClassDeclaration-28] * Constructor - * [constructor(content)][Constructor-20] + * [constructor(body)][Constructor-20] * Properties - * [isHttpResponseInternalServerError][PropertyDeclaration-68] - * [statusCode][PropertyDeclaration-69] - * [statusMessage][PropertyDeclaration-70] + * [isHttpResponseInternalServerError][PropertyDeclaration-66] + * [statusCode][PropertyDeclaration-67] + * [statusMessage][PropertyDeclaration-68] # HttpResponseInternalServerError @@ -15,17 +15,17 @@ class HttpResponseInternalServerError ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-28]: httpresponseinternalservererror.md#httpresponseinternalservererror -[Constructor-20]: httpresponseinternalservererror.md#constructorcontent -[PropertyDeclaration-68]: httpresponseinternalservererror.md#ishttpresponseinternalservererror -[PropertyDeclaration-69]: httpresponseinternalservererror.md#statuscode -[PropertyDeclaration-70]: httpresponseinternalservererror.md#statusmessage \ No newline at end of file +[Constructor-20]: httpresponseinternalservererror.md#constructorbody +[PropertyDeclaration-66]: httpresponseinternalservererror.md#ishttpresponseinternalservererror +[PropertyDeclaration-67]: httpresponseinternalservererror.md#statuscode +[PropertyDeclaration-68]: httpresponseinternalservererror.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponsemethodnotallowed.md b/docs/api/index/httpresponsemethodnotallowed.md index c31d2a5ac7..be1cd04d45 100644 --- a/docs/api/index/httpresponsemethodnotallowed.md +++ b/docs/api/index/httpresponsemethodnotallowed.md @@ -2,11 +2,11 @@ * [HttpResponseMethodNotAllowed][ClassDeclaration-17] * Constructor - * [constructor(content)][Constructor-10] + * [constructor(body)][Constructor-10] * Properties - * [isHttpResponseMethodNotAllowed][PropertyDeclaration-41] - * [statusCode][PropertyDeclaration-42] - * [statusMessage][PropertyDeclaration-43] + * [isHttpResponseMethodNotAllowed][PropertyDeclaration-39] + * [statusCode][PropertyDeclaration-40] + * [statusMessage][PropertyDeclaration-41] # HttpResponseMethodNotAllowed @@ -15,17 +15,17 @@ class HttpResponseMethodNotAllowed ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-17]: httpresponsemethodnotallowed.md#httpresponsemethodnotallowed -[Constructor-10]: httpresponsemethodnotallowed.md#constructorcontent -[PropertyDeclaration-41]: httpresponsemethodnotallowed.md#ishttpresponsemethodnotallowed -[PropertyDeclaration-42]: httpresponsemethodnotallowed.md#statuscode -[PropertyDeclaration-43]: httpresponsemethodnotallowed.md#statusmessage \ No newline at end of file +[Constructor-10]: httpresponsemethodnotallowed.md#constructorbody +[PropertyDeclaration-39]: httpresponsemethodnotallowed.md#ishttpresponsemethodnotallowed +[PropertyDeclaration-40]: httpresponsemethodnotallowed.md#statuscode +[PropertyDeclaration-41]: httpresponsemethodnotallowed.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponsenocontent.md b/docs/api/index/httpresponsenocontent.md index 70a4e7ccbf..c072a6cdc7 100644 --- a/docs/api/index/httpresponsenocontent.md +++ b/docs/api/index/httpresponsenocontent.md @@ -4,9 +4,9 @@ * Constructor * [constructor()][Constructor-4] * Properties - * [isHttpResponseNoContent][PropertyDeclaration-25] - * [statusCode][PropertyDeclaration-26] - * [statusMessage][PropertyDeclaration-27] + * [isHttpResponseNoContent][PropertyDeclaration-24] + * [statusCode][PropertyDeclaration-25] + * [statusMessage][PropertyDeclaration-26] # HttpResponseNoContent @@ -59,6 +59,6 @@ string [ClassDeclaration-10]: httpresponsenocontent.md#httpresponsenocontent [Constructor-4]: httpresponsenocontent.md#constructor -[PropertyDeclaration-25]: httpresponsenocontent.md#ishttpresponsenocontent -[PropertyDeclaration-26]: httpresponsenocontent.md#statuscode -[PropertyDeclaration-27]: httpresponsenocontent.md#statusmessage \ No newline at end of file +[PropertyDeclaration-24]: httpresponsenocontent.md#ishttpresponsenocontent +[PropertyDeclaration-25]: httpresponsenocontent.md#statuscode +[PropertyDeclaration-26]: httpresponsenocontent.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponsenotfound.md b/docs/api/index/httpresponsenotfound.md index a4ce84f76b..3dd82c641c 100644 --- a/docs/api/index/httpresponsenotfound.md +++ b/docs/api/index/httpresponsenotfound.md @@ -2,11 +2,11 @@ * [HttpResponseNotFound][ClassDeclaration-12] * Constructor - * [constructor(content)][Constructor-6] + * [constructor(body)][Constructor-6] * Properties - * [isHttpResponseNotFound][PropertyDeclaration-29] - * [statusCode][PropertyDeclaration-30] - * [statusMessage][PropertyDeclaration-31] + * [isHttpResponseNotFound][PropertyDeclaration-28] + * [statusCode][PropertyDeclaration-29] + * [statusMessage][PropertyDeclaration-30] # HttpResponseNotFound @@ -15,17 +15,17 @@ class HttpResponseNotFound ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-12]: httpresponsenotfound.md#httpresponsenotfound -[Constructor-6]: httpresponsenotfound.md#constructorcontent -[PropertyDeclaration-29]: httpresponsenotfound.md#ishttpresponsenotfound -[PropertyDeclaration-30]: httpresponsenotfound.md#statuscode -[PropertyDeclaration-31]: httpresponsenotfound.md#statusmessage \ No newline at end of file +[Constructor-6]: httpresponsenotfound.md#constructorbody +[PropertyDeclaration-28]: httpresponsenotfound.md#ishttpresponsenotfound +[PropertyDeclaration-29]: httpresponsenotfound.md#statuscode +[PropertyDeclaration-30]: httpresponsenotfound.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponsenotimplemented.md b/docs/api/index/httpresponsenotimplemented.md index 1975940be1..e47c45677c 100644 --- a/docs/api/index/httpresponsenotimplemented.md +++ b/docs/api/index/httpresponsenotimplemented.md @@ -2,11 +2,11 @@ * [HttpResponseNotImplemented][ClassDeclaration-18] * Constructor - * [constructor(content)][Constructor-11] + * [constructor(body)][Constructor-11] * Properties - * [isHttpResponseNotImplemented][PropertyDeclaration-44] - * [statusCode][PropertyDeclaration-45] - * [statusMessage][PropertyDeclaration-46] + * [isHttpResponseNotImplemented][PropertyDeclaration-42] + * [statusCode][PropertyDeclaration-43] + * [statusMessage][PropertyDeclaration-44] # HttpResponseNotImplemented @@ -15,17 +15,17 @@ class HttpResponseNotImplemented ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented -[Constructor-11]: httpresponsenotimplemented.md#constructorcontent -[PropertyDeclaration-44]: httpresponsenotimplemented.md#ishttpresponsenotimplemented -[PropertyDeclaration-45]: httpresponsenotimplemented.md#statuscode -[PropertyDeclaration-46]: httpresponsenotimplemented.md#statusmessage \ No newline at end of file +[Constructor-11]: httpresponsenotimplemented.md#constructorbody +[PropertyDeclaration-42]: httpresponsenotimplemented.md#ishttpresponsenotimplemented +[PropertyDeclaration-43]: httpresponsenotimplemented.md#statuscode +[PropertyDeclaration-44]: httpresponsenotimplemented.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponseok.md b/docs/api/index/httpresponseok.md index ebe6320235..3c44f02419 100644 --- a/docs/api/index/httpresponseok.md +++ b/docs/api/index/httpresponseok.md @@ -2,11 +2,11 @@ * [HttpResponseOK][ClassDeclaration-20] * Constructor - * [constructor(content)][Constructor-13] + * [constructor(body)][Constructor-13] * Properties - * [isHttpResponseOK][PropertyDeclaration-48] - * [statusCode][PropertyDeclaration-49] - * [statusMessage][PropertyDeclaration-50] + * [isHttpResponseOK][PropertyDeclaration-46] + * [statusCode][PropertyDeclaration-47] + * [statusMessage][PropertyDeclaration-48] # HttpResponseOK @@ -15,17 +15,17 @@ class HttpResponseOK ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,7 +64,7 @@ public statusMessage: string; string [ClassDeclaration-20]: httpresponseok.md#httpresponseok -[Constructor-13]: httpresponseok.md#constructorcontent -[PropertyDeclaration-48]: httpresponseok.md#ishttpresponseok -[PropertyDeclaration-49]: httpresponseok.md#statuscode -[PropertyDeclaration-50]: httpresponseok.md#statusmessage \ No newline at end of file +[Constructor-13]: httpresponseok.md#constructorbody +[PropertyDeclaration-46]: httpresponseok.md#ishttpresponseok +[PropertyDeclaration-47]: httpresponseok.md#statuscode +[PropertyDeclaration-48]: httpresponseok.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponseredirect.md b/docs/api/index/httpresponseredirect.md index 17d99de2a2..9281337eac 100644 --- a/docs/api/index/httpresponseredirect.md +++ b/docs/api/index/httpresponseredirect.md @@ -2,7 +2,7 @@ * [HttpResponseRedirect][ClassDeclaration-7] * Constructor - * [constructor(path, content)][Constructor-1] + * [constructor(path, body)][Constructor-1] * Properties * [isHttpResponseRedirect][PropertyDeclaration-17] * [statusCode][PropertyDeclaration-18] @@ -15,18 +15,18 @@ class HttpResponseRedirect ``` ## Constructor -### constructor(path, content) +### constructor(path, body) ```typescript -public constructor(path: string, content?: any); +public constructor(path: string, body?: any); ``` **Parameters** -| Name | Type | -| ------- | ------ | -| path | string | -| content | any | +| Name | Type | +| ---- | ------ | +| path | string | +| body | any | ## Properties @@ -65,7 +65,7 @@ public statusMessage: string; string [ClassDeclaration-7]: httpresponseredirect.md#httpresponseredirect -[Constructor-1]: httpresponseredirect.md#constructorpath-content +[Constructor-1]: httpresponseredirect.md#constructorpath-body [PropertyDeclaration-17]: httpresponseredirect.md#ishttpresponseredirect [PropertyDeclaration-18]: httpresponseredirect.md#statuscode [PropertyDeclaration-19]: httpresponseredirect.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/httpresponseredirection.md b/docs/api/index/httpresponseredirection.md index 13aebd41e0..6bebbd593e 100644 --- a/docs/api/index/httpresponseredirection.md +++ b/docs/api/index/httpresponseredirection.md @@ -2,7 +2,7 @@ * [HttpResponseRedirection][ClassDeclaration-8] * Constructor - * [constructor(content)][Constructor-2] + * [constructor(body)][Constructor-2] * Properties * [isHttpResponseRedirection][PropertyDeclaration-20] @@ -13,17 +13,17 @@ abstract class HttpResponseRedirection ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -38,5 +38,5 @@ public readonly isHttpResponseRedirection: true; true [ClassDeclaration-8]: httpresponseredirection.md#httpresponseredirection -[Constructor-2]: httpresponseredirection.md#constructorcontent +[Constructor-2]: httpresponseredirection.md#constructorbody [PropertyDeclaration-20]: httpresponseredirection.md#ishttpresponseredirection \ No newline at end of file diff --git a/docs/api/index/httpresponseservererror.md b/docs/api/index/httpresponseservererror.md index 5ca6901224..fb8faeaedd 100644 --- a/docs/api/index/httpresponseservererror.md +++ b/docs/api/index/httpresponseservererror.md @@ -2,9 +2,9 @@ * [HttpResponseServerError][ClassDeclaration-19] * Constructor - * [constructor(content)][Constructor-12] + * [constructor(body)][Constructor-12] * Properties - * [isHttpResponseServerError][PropertyDeclaration-47] + * [isHttpResponseServerError][PropertyDeclaration-45] # HttpResponseServerError @@ -13,17 +13,17 @@ abstract class HttpResponseServerError ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -38,5 +38,5 @@ public readonly isHttpResponseServerError: true; true [ClassDeclaration-19]: httpresponseservererror.md#httpresponseservererror -[Constructor-12]: httpresponseservererror.md#constructorcontent -[PropertyDeclaration-47]: httpresponseservererror.md#ishttpresponseservererror \ No newline at end of file +[Constructor-12]: httpresponseservererror.md#constructorbody +[PropertyDeclaration-45]: httpresponseservererror.md#ishttpresponseservererror \ No newline at end of file diff --git a/docs/api/index/httpresponsesuccess.md b/docs/api/index/httpresponsesuccess.md index ef81bd771f..62c328200f 100644 --- a/docs/api/index/httpresponsesuccess.md +++ b/docs/api/index/httpresponsesuccess.md @@ -2,9 +2,9 @@ * [HttpResponseSuccess][ClassDeclaration-11] * Constructor - * [constructor(content)][Constructor-5] + * [constructor(body)][Constructor-5] * Properties - * [isHttpResponseSuccess][PropertyDeclaration-28] + * [isHttpResponseSuccess][PropertyDeclaration-27] # HttpResponseSuccess @@ -13,17 +13,17 @@ abstract class HttpResponseSuccess ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -38,5 +38,5 @@ public readonly isHttpResponseSuccess: true; true [ClassDeclaration-11]: httpresponsesuccess.md#httpresponsesuccess -[Constructor-5]: httpresponsesuccess.md#constructorcontent -[PropertyDeclaration-28]: httpresponsesuccess.md#ishttpresponsesuccess \ No newline at end of file +[Constructor-5]: httpresponsesuccess.md#constructorbody +[PropertyDeclaration-27]: httpresponsesuccess.md#ishttpresponsesuccess \ No newline at end of file diff --git a/docs/api/index/httpresponseunauthorized.md b/docs/api/index/httpresponseunauthorized.md index fb10b0afc0..3f879aa695 100644 --- a/docs/api/index/httpresponseunauthorized.md +++ b/docs/api/index/httpresponseunauthorized.md @@ -2,12 +2,11 @@ * [HttpResponseUnauthorized][ClassDeclaration-15] * Constructor - * [constructor(content)][Constructor-9] + * [constructor(body)][Constructor-9] * Properties - * [isHttpResponseUnauthorized][PropertyDeclaration-36] - * [statusCode][PropertyDeclaration-37] - * [statusMessage][PropertyDeclaration-38] - * [headers][PropertyDeclaration-39] + * [isHttpResponseUnauthorized][PropertyDeclaration-35] + * [statusCode][PropertyDeclaration-36] + * [statusMessage][PropertyDeclaration-37] # HttpResponseUnauthorized @@ -16,17 +15,17 @@ class HttpResponseUnauthorized ``` ## Constructor -### constructor(content) +### constructor(body) ```typescript -public constructor(content?: any); +public constructor(body?: any); ``` **Parameters** -| Name | Type | -| ------- | ---- | -| content | any | +| Name | Type | +| ---- | ---- | +| body | any | ## Properties @@ -64,21 +63,8 @@ public statusMessage: string; string ----------- - -### headers - -```typescript -public headers: { WWW-Authenticate: string; }; -``` - -**Type** - -{ WWW-Authenticate: string; } - [ClassDeclaration-15]: httpresponseunauthorized.md#httpresponseunauthorized -[Constructor-9]: httpresponseunauthorized.md#constructorcontent -[PropertyDeclaration-36]: httpresponseunauthorized.md#ishttpresponseunauthorized -[PropertyDeclaration-37]: httpresponseunauthorized.md#statuscode -[PropertyDeclaration-38]: httpresponseunauthorized.md#statusmessage -[PropertyDeclaration-39]: httpresponseunauthorized.md#headers \ No newline at end of file +[Constructor-9]: httpresponseunauthorized.md#constructorbody +[PropertyDeclaration-35]: httpresponseunauthorized.md#ishttpresponseunauthorized +[PropertyDeclaration-36]: httpresponseunauthorized.md#statuscode +[PropertyDeclaration-37]: httpresponseunauthorized.md#statusmessage \ No newline at end of file diff --git a/docs/api/index/logincontroller.md b/docs/api/index/logincontroller.md index 940d367ef6..2794a9d92f 100644 --- a/docs/api/index/logincontroller.md +++ b/docs/api/index/logincontroller.md @@ -3,7 +3,7 @@ * [LoginController][ClassDeclaration-4] * Methods * [logout(ctx)][MethodDeclaration-5] - * [login(ctx)][MethodDeclaration-6] + * [login(ctx)][MethodDeclaration-12] * Properties * [redirect][PropertyDeclaration-11] * [strategies][PropertyDeclaration-12] @@ -92,7 +92,7 @@ public services: ServiceManager; [ClassDeclaration-6]: context.md#context [ClassDeclaration-7]: httpresponseredirect.md#httpresponseredirect [ClassDeclaration-10]: httpresponsenocontent.md#httpresponsenocontent -[MethodDeclaration-6]: logincontroller.md#loginctx +[MethodDeclaration-12]: logincontroller.md#loginctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-7]: httpresponseredirect.md#httpresponseredirect diff --git a/docs/api/index/objectdoesnotexist.md b/docs/api/index/objectdoesnotexist.md index 00358fd3ca..c18d73a3aa 100644 --- a/docs/api/index/objectdoesnotexist.md +++ b/docs/api/index/objectdoesnotexist.md @@ -4,7 +4,7 @@ * Constructor * [constructor(content)][Constructor-16] * Properties - * [isObjectDoesNotExist][PropertyDeclaration-57] + * [isObjectDoesNotExist][PropertyDeclaration-55] # ObjectDoesNotExist @@ -39,4 +39,4 @@ true [ClassDeclaration-23]: objectdoesnotexist.md#objectdoesnotexist [Constructor-16]: objectdoesnotexist.md#constructorcontent -[PropertyDeclaration-57]: objectdoesnotexist.md#isobjectdoesnotexist \ No newline at end of file +[PropertyDeclaration-55]: objectdoesnotexist.md#isobjectdoesnotexist \ No newline at end of file diff --git a/docs/api/index/permissiondenied.md b/docs/api/index/permissiondenied.md index 0f394fc5b4..9bac46ceb5 100644 --- a/docs/api/index/permissiondenied.md +++ b/docs/api/index/permissiondenied.md @@ -4,7 +4,7 @@ * Constructor * [constructor(content)][Constructor-17] * Properties - * [isPermissionDenied][PropertyDeclaration-58] + * [isPermissionDenied][PropertyDeclaration-56] # PermissionDenied @@ -39,4 +39,4 @@ true [ClassDeclaration-24]: permissiondenied.md#permissiondenied [Constructor-17]: permissiondenied.md#constructorcontent -[PropertyDeclaration-58]: permissiondenied.md#ispermissiondenied \ No newline at end of file +[PropertyDeclaration-56]: permissiondenied.md#ispermissiondenied \ No newline at end of file diff --git a/docs/api/index/restcontroller.md b/docs/api/index/restcontroller.md index c2f31b020d..0d2a7a0625 100644 --- a/docs/api/index/restcontroller.md +++ b/docs/api/index/restcontroller.md @@ -2,19 +2,19 @@ * [RestController][ClassDeclaration-16] * Methods - * [extendParams(ctx, params)][MethodDeclaration-7] - * [delete()][MethodDeclaration-8] - * [deleteById(ctx)][MethodDeclaration-9] - * [get(ctx)][MethodDeclaration-10] - * [getById(ctx)][MethodDeclaration-11] - * [patch()][MethodDeclaration-12] - * [patchById(ctx)][MethodDeclaration-13] - * [post(ctx)][MethodDeclaration-14] - * [postById()][MethodDeclaration-15] - * [put()][MethodDeclaration-16] - * [putById(ctx)][MethodDeclaration-17] + * [extendParams(ctx, params)][MethodDeclaration-13] + * [delete()][MethodDeclaration-14] + * [deleteById(ctx)][MethodDeclaration-15] + * [get(ctx)][MethodDeclaration-16] + * [getById(ctx)][MethodDeclaration-17] + * [patch()][MethodDeclaration-18] + * [patchById(ctx)][MethodDeclaration-19] + * [post(ctx)][MethodDeclaration-20] + * [postById()][MethodDeclaration-21] + * [put()][MethodDeclaration-22] + * [putById(ctx)][MethodDeclaration-23] * Properties - * [collection][PropertyDeclaration-40] + * [collection][PropertyDeclaration-38] # RestController @@ -34,11 +34,11 @@ public extendParams(ctx: Context, params: CollectionParams): Colle | Name | Type | | ------ | ----------------------------------------------------------------- | | ctx | [Context][ClassDeclaration-6]<[AbstractUser][ClassDeclaration-1]> | -| params | [CollectionParams][InterfaceDeclaration-5] | +| params | [CollectionParams][InterfaceDeclaration-6] | **Return type** -[CollectionParams][InterfaceDeclaration-5] +[CollectionParams][InterfaceDeclaration-6] ---------- @@ -206,17 +206,17 @@ public abstract collection: Partial; **Type** -Partial<[IResourceCollection][InterfaceDeclaration-4]> +Partial<[IResourceCollection][InterfaceDeclaration-5]> [ClassDeclaration-16]: restcontroller.md#restcontroller -[MethodDeclaration-7]: restcontroller.md#extendparamsctx-params +[MethodDeclaration-13]: restcontroller.md#extendparamsctx-params [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context -[InterfaceDeclaration-5]: ../index.md#collectionparams -[InterfaceDeclaration-5]: ../index.md#collectionparams -[MethodDeclaration-8]: restcontroller.md#delete +[InterfaceDeclaration-6]: ../index.md#collectionparams +[InterfaceDeclaration-6]: ../index.md#collectionparams +[MethodDeclaration-14]: restcontroller.md#delete [ClassDeclaration-17]: httpresponsemethodnotallowed.md#httpresponsemethodnotallowed -[MethodDeclaration-9]: restcontroller.md#deletebyidctx +[MethodDeclaration-15]: restcontroller.md#deletebyidctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-12]: httpresponsenotfound.md#httpresponsenotfound @@ -224,14 +224,14 @@ Partial<[IResourceCollection][InterfaceDeclaration-4]> [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented [ClassDeclaration-20]: httpresponseok.md#httpresponseok [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden -[MethodDeclaration-10]: restcontroller.md#getctx +[MethodDeclaration-16]: restcontroller.md#getctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-14]: httpresponsebadrequest.md#httpresponsebadrequest [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented [ClassDeclaration-20]: httpresponseok.md#httpresponseok [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden -[MethodDeclaration-11]: restcontroller.md#getbyidctx +[MethodDeclaration-17]: restcontroller.md#getbyidctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-12]: httpresponsenotfound.md#httpresponsenotfound @@ -239,9 +239,9 @@ Partial<[IResourceCollection][InterfaceDeclaration-4]> [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented [ClassDeclaration-20]: httpresponseok.md#httpresponseok [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden -[MethodDeclaration-12]: restcontroller.md#patch +[MethodDeclaration-18]: restcontroller.md#patch [ClassDeclaration-17]: httpresponsemethodnotallowed.md#httpresponsemethodnotallowed -[MethodDeclaration-13]: restcontroller.md#patchbyidctx +[MethodDeclaration-19]: restcontroller.md#patchbyidctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-12]: httpresponsenotfound.md#httpresponsenotfound @@ -249,18 +249,18 @@ Partial<[IResourceCollection][InterfaceDeclaration-4]> [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented [ClassDeclaration-20]: httpresponseok.md#httpresponseok [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden -[MethodDeclaration-14]: restcontroller.md#postctx +[MethodDeclaration-20]: restcontroller.md#postctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-14]: httpresponsebadrequest.md#httpresponsebadrequest [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden [ClassDeclaration-22]: httpresponsecreated.md#httpresponsecreated -[MethodDeclaration-15]: restcontroller.md#postbyid +[MethodDeclaration-21]: restcontroller.md#postbyid [ClassDeclaration-17]: httpresponsemethodnotallowed.md#httpresponsemethodnotallowed -[MethodDeclaration-16]: restcontroller.md#put +[MethodDeclaration-22]: restcontroller.md#put [ClassDeclaration-17]: httpresponsemethodnotallowed.md#httpresponsemethodnotallowed -[MethodDeclaration-17]: restcontroller.md#putbyidctx +[MethodDeclaration-23]: restcontroller.md#putbyidctx [ClassDeclaration-1]: abstractuser.md#abstractuser [ClassDeclaration-6]: context.md#context [ClassDeclaration-12]: httpresponsenotfound.md#httpresponsenotfound @@ -268,5 +268,5 @@ Partial<[IResourceCollection][InterfaceDeclaration-4]> [ClassDeclaration-18]: httpresponsenotimplemented.md#httpresponsenotimplemented [ClassDeclaration-20]: httpresponseok.md#httpresponseok [ClassDeclaration-21]: httpresponseforbidden.md#httpresponseforbidden -[PropertyDeclaration-40]: restcontroller.md#collection -[InterfaceDeclaration-4]: ../index.md#iresourcecollection \ No newline at end of file +[PropertyDeclaration-38]: restcontroller.md#collection +[InterfaceDeclaration-5]: ../index.md#iresourcecollection \ No newline at end of file diff --git a/docs/api/index/validationerror.md b/docs/api/index/validationerror.md index 3c10c5ee3a..1d838d5c4c 100644 --- a/docs/api/index/validationerror.md +++ b/docs/api/index/validationerror.md @@ -4,7 +4,7 @@ * Constructor * [constructor(content)][Constructor-18] * Properties - * [isValidationError][PropertyDeclaration-59] + * [isValidationError][PropertyDeclaration-57] # ValidationError @@ -39,4 +39,4 @@ true [ClassDeclaration-25]: validationerror.md#validationerror [Constructor-18]: validationerror.md#constructorcontent -[PropertyDeclaration-59]: validationerror.md#isvalidationerror \ No newline at end of file +[PropertyDeclaration-57]: validationerror.md#isvalidationerror \ No newline at end of file