diff --git a/changelog.html b/changelog.html index 61b6b6d9..64e5ff44 100644 --- a/changelog.html +++ b/changelog.html @@ -12,6 +12,64 @@
+import { AutoIncrementID } from '@typegoose/auto-increment'
import { prop, plugin, modelOptions } from '@typegoose/typegoose'
import { IsString, IsInt, IsIn, IsDefined, IsNotEmpty } from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { PublishState } from '@app/constants/biz.constant'
@@ -344,7 +402,7 @@
export const ANNOUNCEMENT_STATES = [PublishState.Draft, PublishState.Published] as const
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
schemaOptions: {
versionKey: false,
diff --git a/classes/AnnouncementPaginateQueryDTO.html b/classes/AnnouncementPaginateQueryDTO.html
index c6decc0f..05270a63 100644
--- a/classes/AnnouncementPaginateQueryDTO.html
+++ b/classes/AnnouncementPaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,6 +131,12 @@ File
+
+
Extends
+
+
+ IntersectionType(PaginateOptionDTO, KeywordQueryDTO)
+
diff --git a/classes/AnnouncementsDTO.html b/classes/AnnouncementsDTO.html
index b2f04e82..c1826709 100644
--- a/classes/AnnouncementsDTO.html
+++ b/classes/AnnouncementsDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/AppMeta.html b/classes/AppMeta.html
index 600fc820..c0a67b06 100644
--- a/classes/AppMeta.html
+++ b/classes/AppMeta.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/Article.html b/classes/Article.html
index c8b74f7c..87646d38 100644
--- a/classes/Article.html
+++ b/classes/Article.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -966,7 +1024,7 @@
ArrayUnique
} from 'class-validator'
import { Language, SortType, PublishState, PublicState, OriginState } from '@app/constants/biz.constant'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { Category } from '@app/modules/category/category.model'
@@ -1015,7 +1073,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
schemaOptions: {
versionKey: false,
diff --git a/classes/ArticleCalendarQueryDTO.html b/classes/ArticleCalendarQueryDTO.html
index d6499209..4a4e75b0 100644
--- a/classes/ArticleCalendarQueryDTO.html
+++ b/classes/ArticleCalendarQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/ArticleIDsDTO.html b/classes/ArticleIDsDTO.html
index ede973c8..73ee201e 100644
--- a/classes/ArticleIDsDTO.html
+++ b/classes/ArticleIDsDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/ArticleMeta.html b/classes/ArticleMeta.html
index 598cec77..c7553682 100644
--- a/classes/ArticleMeta.html
+++ b/classes/ArticleMeta.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -262,7 +320,7 @@
ArrayUnique
} from 'class-validator'
import { Language, SortType, PublishState, PublicState, OriginState } from '@app/constants/biz.constant'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { Category } from '@app/modules/category/category.model'
@@ -311,7 +369,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
schemaOptions: {
versionKey: false,
diff --git a/classes/ArticlePaginateQueryDTO.html b/classes/ArticlePaginateQueryDTO.html
index 48669420..97ce8134 100644
--- a/classes/ArticlePaginateQueryDTO.html
+++ b/classes/ArticlePaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,6 +131,16 @@ File
+
+
Extends
+
+
+ IntersectionType(
+ PaginateOptionWithHotSortDTO,
+ KeywordQueryDTO,
+ DateQueryDTO
+)
+
diff --git a/classes/ArticlesStateDTO.html b/classes/ArticlesStateDTO.html
index cc60a790..b149cd18 100644
--- a/classes/ArticlesStateDTO.html
+++ b/classes/ArticlesStateDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- ArticleIDsDTO
+ ArticleIDsDTO
diff --git a/classes/Auth.html b/classes/Auth.html
index 4c9f78f7..4b35ed12 100644
--- a/classes/Auth.html
+++ b/classes/Auth.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/AuthLoginDTO.html b/classes/AuthLoginDTO.html
index 0fc0a92d..6315d9ab 100644
--- a/classes/AuthLoginDTO.html
+++ b/classes/AuthLoginDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/AuthUpdateDTO.html b/classes/AuthUpdateDTO.html
index 02693c57..bd8c0d7a 100644
--- a/classes/AuthUpdateDTO.html
+++ b/classes/AuthUpdateDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
diff --git a/classes/Author.html b/classes/Author.html
index 08eb5a87..fb522b2d 100644
--- a/classes/Author.html
+++ b/classes/Author.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -322,7 +380,7 @@
ValidateNested,
ArrayUnique
} from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { mongoosePaginate } from '@app/utils/paginate'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { decodeMD5 } from '@app/transformers/codec.transformer'
@@ -407,7 +465,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
// https://typegoose.github.io/typegoose/docs/api/decorators/model-options/#allowmixed
options: { allowMixed: Severity.ALLOW },
diff --git a/classes/Blocklist.html b/classes/Blocklist.html
index da99b796..20a49834 100644
--- a/classes/Blocklist.html
+++ b/classes/Blocklist.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/BooleanQueryDTO.html b/classes/BooleanQueryDTO.html
index 9515a356..67d22b5d 100644
--- a/classes/BooleanQueryDTO.html
+++ b/classes/BooleanQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/CallbackCodeDTO.html b/classes/CallbackCodeDTO.html
index baec0fee..5db565ea 100644
--- a/classes/CallbackCodeDTO.html
+++ b/classes/CallbackCodeDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/CategoriesDTO.html b/classes/CategoriesDTO.html
index 69e7430c..d1986b5b 100644
--- a/classes/CategoriesDTO.html
+++ b/classes/CategoriesDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/Category.html b/classes/Category.html
index 48a7ab8f..342b73a6 100644
--- a/classes/Category.html
+++ b/classes/Category.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -496,13 +554,13 @@
import { AutoIncrementID } from '@typegoose/auto-increment'
import { prop, plugin, modelOptions } from '@typegoose/typegoose'
import { IsString, MaxLength, Matches, IsNotEmpty, IsArray, ArrayUnique } from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { KeyValueModel } from '@app/models/key-value.model'
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
schemaOptions: {
versionKey: false,
diff --git a/classes/CategoryPaginateQueryDTO.html b/classes/CategoryPaginateQueryDTO.html
index 8ec72793..bee88165 100644
--- a/classes/CategoryPaginateQueryDTO.html
+++ b/classes/CategoryPaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- PaginateOptionDTO
+ PaginateOptionDTO
diff --git a/classes/Comment.html b/classes/Comment.html
index 48b32398..a0612124 100644
--- a/classes/Comment.html
+++ b/classes/Comment.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,12 +131,6 @@ File
-
-
Extends
-
-
- CommentBase
-
@@ -141,40 +193,6 @@ Properties
Optional
updated_at
-
-
-
- Optional
- agent
-
-
-
-
-
-
-
-
- author
-
-
-
-
-
-
-
- content
-
-
-
-
- pid
-
-
-
-
-
- post_id
-
@@ -527,235 +545,6 @@
-
-
-
-
-
-
-
-
-
-
- Optional
- agent
-
-
-
-
-
-
- Type : string | null
-
-
-
-
-
- Decorators :
-
-
- @IsString()
@prop({type: String, default: undefined})
-
-
-
-
-
- Inherited from CommentBase
-
-
-
-
-
- Defined in CommentBase:100
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- author
-
-
-
-
-
-
- Type : Author
-
-
-
-
-
- Decorators :
-
-
- @Type(undefined)
@ValidateNested()
@IsObject()
@IsNotEmpty()
@IsDefined({message: 'comment author?'})
@prop({required: true, _id: false})
-
-
-
-
-
- Inherited from CommentBase
-
-
-
-
-
- Defined in CommentBase:108
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- content
-
-
-
-
-
-
- Type : string
-
-
-
-
-
- Decorators :
-
-
- @MinLength(3)
@MaxLength(3000)
@IsString()
@IsNotEmpty({message: 'comment content?'})
@prop({required: true, validate: /\S+/})
-
-
-
-
-
- Inherited from CommentBase
-
-
-
-
-
- Defined in CommentBase:95
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- pid
-
-
-
-
-
-
- Type : number
-
-
-
-
-
- Decorators :
-
-
- @IsInt()
@prop({default: ROOT_COMMENT_PID, index: true})
-
-
-
-
-
- Inherited from CommentBase
-
-
-
-
-
- Defined in CommentBase:88
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- post_id
-
-
-
-
-
-
- Type : number
-
-
-
-
-
- Decorators :
-
-
- @IsInt()
@IsNotEmpty({message: 'post ID?'})
@prop({required: true, index: true})
-
-
-
-
-
- Inherited from CommentBase
-
-
-
-
-
- Defined in CommentBase:83
-
-
-
-
-
@@ -790,7 +579,7 @@
ValidateNested,
ArrayUnique
} from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { mongoosePaginate } from '@app/utils/paginate'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { decodeMD5 } from '@app/transformers/codec.transformer'
@@ -875,7 +664,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
// https://typegoose.github.io/typegoose/docs/api/decorators/model-options/#allowmixed
options: { allowMixed: Severity.ALLOW },
diff --git a/classes/CommentBase.html b/classes/CommentBase.html
index 6b3d16b7..60600ffb 100644
--- a/classes/CommentBase.html
+++ b/classes/CommentBase.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -367,7 +425,7 @@
ValidateNested,
ArrayUnique
} from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { mongoosePaginate } from '@app/utils/paginate'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { decodeMD5 } from '@app/transformers/codec.transformer'
@@ -452,7 +510,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
// https://typegoose.github.io/typegoose/docs/api/decorators/model-options/#allowmixed
options: { allowMixed: Severity.ALLOW },
diff --git a/classes/CommentCalendarQueryDTO.html b/classes/CommentCalendarQueryDTO.html
index de376aa8..421d8d38 100644
--- a/classes/CommentCalendarQueryDTO.html
+++ b/classes/CommentCalendarQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/CommentIdDTO.html b/classes/CommentIdDTO.html
index 86c8dced..6fa867b0 100644
--- a/classes/CommentIdDTO.html
+++ b/classes/CommentIdDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/CommentPaginateQueryDTO.html b/classes/CommentPaginateQueryDTO.html
index 7c8a6ba2..3728e0ba 100644
--- a/classes/CommentPaginateQueryDTO.html
+++ b/classes/CommentPaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,6 +131,12 @@ File
+
+
Extends
+
+
+ IntersectionType(PaginateOptionWithHotSortDTO, KeywordQueryDTO)
+
diff --git a/classes/CommentVoteDTO.html b/classes/CommentVoteDTO.html
index eb141db5..7fb8c895 100644
--- a/classes/CommentVoteDTO.html
+++ b/classes/CommentVoteDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- VoteAuthorDTO
+ VoteAuthorDTO
diff --git a/classes/CommentsDTO.html b/classes/CommentsDTO.html
index 5be42e59..2d78e3d3 100644
--- a/classes/CommentsDTO.html
+++ b/classes/CommentsDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/CommentsStateDTO.html b/classes/CommentsStateDTO.html
index 890678b3..fc77c6d8 100644
--- a/classes/CommentsStateDTO.html
+++ b/classes/CommentsStateDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
diff --git a/classes/CustomError.html b/classes/CustomError.html
index c35fad58..fdb655b7 100644
--- a/classes/CustomError.html
+++ b/classes/CustomError.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -76,14 +134,14 @@ File
Description
-
```html
+ Example :```html
Extends
- HttpException
+ HttpException
diff --git a/classes/DateQueryDTO.html b/classes/DateQueryDTO.html
index 3d69e7bb..d8522d68 100644
--- a/classes/DateQueryDTO.html
+++ b/classes/DateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/Disqus.html b/classes/Disqus.html
index 0f827265..ce1e7c10 100644
--- a/classes/Disqus.html
+++ b/classes/Disqus.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -226,7 +284,7 @@
- Public
+ Public
getAuthorizeURL
@@ -234,91 +292,89 @@
-
+
getAuthorizeURL(type: string, scope: string, uri: string)
-
-
- Defined in src/utils/disqus.ts:114
-
-
+
+
+ Defined in src/utils/disqus.ts:114
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
- Default value
-
-
-
-
- type
-
- string
-
-
-
- No
-
-
-
- 'code'
-
-
-
-
- scope
-
- string
-
-
-
- No
-
-
-
-
-
-
-
- uri
-
- string
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+ Default value
+
+
+
+
+ type
+
+ string
+
+
+
+ No
+
+
+
+ 'code'
+
+
+
+
+ scope
+
+ string
+
+
+
+ No
+
+
+
+
+
+
+
+ uri
+
+ string
+
+
+
+ No
+
+
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -329,7 +385,7 @@
- Public
+ Public
getOAuthAccessToken
@@ -337,71 +393,69 @@
-
+
getOAuthAccessToken(code: string, uri: string)
-
-
- Defined in src/utils/disqus.ts:123
-
-
+
+
+ Defined in src/utils/disqus.ts:123
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- code
-
- string
-
-
-
- No
-
-
-
-
-
- uri
-
- string
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ code
+
+ string
+
+
+
+ No
+
+
+
+
+
+ uri
+
+ string
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -412,7 +466,7 @@
- Public
+ Public
refreshOAuthAccessToken
@@ -420,67 +474,65 @@
-
+
refreshOAuthAccessToken(refreshToken: string)
-
-
- Defined in src/utils/disqus.ts:141
-
-
+
+
+ Defined in src/utils/disqus.ts:141
+
+
-
-
- Type parameters :
-
- - T
-
-
-
+
+
+ Type parameters :
+
+ - T
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- refreshToken
-
- string
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ refreshToken
+
+ string
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -491,7 +543,7 @@
- Public
+ Public
request
@@ -499,99 +551,97 @@
-
+
request(resource: string, params: RequestParams, usePublic)
-
-
- Defined in src/utils/disqus.ts:88
-
-
+
+
+ Defined in src/utils/disqus.ts:88
+
+
-
-
- Type parameters :
-
- - T
-
-
-
+
+
+ Type parameters :
+
+ - T
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
- Default value
-
-
-
-
- resource
-
- string
-
-
-
- No
-
-
-
-
-
-
-
- params
-
- RequestParams
-
-
-
- No
-
-
-
- {}
-
-
-
-
- usePublic
-
-
-
-
- No
-
-
-
- false
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+ Default value
+
+
+
+
+ resource
+
+ string
+
+
+
+ No
+
+
+
+
+
+
+
+ params
+
+ RequestParams
+
+
+
+ No
+
+
+
+ {}
+
+
+
+
+ usePublic
+
+
+
+
+ No
+
+
+
+ false
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/classes/Feedback.html b/classes/Feedback.html
index 7bb6d228..a1a13f43 100644
--- a/classes/Feedback.html
+++ b/classes/Feedback.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,12 +131,6 @@ File
-
-
Extends
-
-
- FeedbackBase
-
@@ -141,42 +193,6 @@ Properties
Optional
user_agent
-
-
-
-
-
-
- content
-
-
-
-
-
-
- emotion
-
-
-
-
-
-
- tid
-
-
-
-
-
-
- user_email
-
-
-
-
-
-
- user_name
-
@@ -529,237 +545,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
- content
-
-
-
-
-
-
- Type : string
-
-
-
-
-
- Decorators :
-
-
- @MinLength(3)
@MaxLength(3000)
@IsString()
@IsNotEmpty()
@prop({required: true, validate: /\S+/})
-
-
-
-
-
- Inherited from FeedbackBase
-
-
-
-
-
- Defined in FeedbackBase:94
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- emotion
-
-
-
-
-
-
- Type : number
-
-
-
-
-
- Decorators :
-
-
- @IsIn(FEEDBACK_EMOTION_VALUES)
@IsInt()
@IsNotEmpty()
@prop({required: true, index: true})
-
-
-
-
-
- Inherited from FeedbackBase
-
-
-
-
-
- Defined in FeedbackBase:79
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- tid
-
-
-
-
-
-
- Type : number
-
-
-
-
-
- Decorators :
-
-
- @Min(0)
@IsInt()
@IsNotEmpty()
@prop({required: true, index: true})
-
-
-
-
-
- Inherited from FeedbackBase
-
-
-
-
-
- Defined in FeedbackBase:73
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- user_email
-
-
-
-
-
-
- Type : string | null
-
-
-
-
-
- Decorators :
-
-
- @IsEmail()
@IsString()
@IsOptional()
@prop({type: String, default: undefined})
-
-
-
-
-
- Inherited from FeedbackBase
-
-
-
-
-
- Defined in FeedbackBase:106
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- user_name
-
-
-
-
-
-
- Type : string | null
-
-
-
-
-
- Decorators :
-
-
- @MaxLength(20)
@IsString()
@IsOptional()
@prop({type: String, default: undefined})
-
-
-
-
-
- Inherited from FeedbackBase
-
-
-
-
-
- Defined in FeedbackBase:100
-
-
-
-
-
@@ -789,7 +574,7 @@
IsOptional,
IsNotEmpty
} from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { IPLocation } from '@app/processors/helper/helper.service.ip'
@@ -877,7 +662,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
options: { allowMixed: Severity.ALLOW },
schemaOptions: {
diff --git a/classes/FeedbackBase.html b/classes/FeedbackBase.html
index f5671c16..9a880422 100644
--- a/classes/FeedbackBase.html
+++ b/classes/FeedbackBase.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -432,7 +490,7 @@
IsOptional,
IsNotEmpty
} from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { IPLocation } from '@app/processors/helper/helper.service.ip'
@@ -520,7 +578,7 @@
}
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
options: { allowMixed: Severity.ALLOW },
schemaOptions: {
diff --git a/classes/FeedbackPaginateQueryDTO.html b/classes/FeedbackPaginateQueryDTO.html
index 45339ed3..072fe13d 100644
--- a/classes/FeedbackPaginateQueryDTO.html
+++ b/classes/FeedbackPaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,6 +131,12 @@ File
+
+
Extends
+
+
+ IntersectionType(PaginateOptionDTO, KeywordQueryDTO)
+
diff --git a/classes/FeedbacksDTO.html b/classes/FeedbacksDTO.html
index e597c03d..efa40d55 100644
--- a/classes/FeedbacksDTO.html
+++ b/classes/FeedbacksDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/HttpBadRequestError.html b/classes/HttpBadRequestError.html
index 4ea1b7d6..921e541c 100644
--- a/classes/HttpBadRequestError.html
+++ b/classes/HttpBadRequestError.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -76,14 +134,14 @@ File
Description
-
```html
+ Example :```html
Extends
- HttpException
+ HttpException
diff --git a/classes/HttpExceptionFilter.html b/classes/HttpExceptionFilter.html
index 74fa725f..fea04b2b 100644
--- a/classes/HttpExceptionFilter.html
+++ b/classes/HttpExceptionFilter.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -135,65 +193,63 @@
-
-
- Defined in src/filters/error.filter.ts:19
-
-
+
+
+ Defined in src/filters/error.filter.ts:19
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- exception
-
- HttpException
-
-
-
- No
-
-
-
-
-
- host
-
- ArgumentsHost
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ exception
+
+ HttpException
+
+
+
+ No
+
+
+
+
+
+ host
+
+ ArgumentsHost
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/classes/HttpForbiddenError.html b/classes/HttpForbiddenError.html
index 01df1497..a4284378 100644
--- a/classes/HttpForbiddenError.html
+++ b/classes/HttpForbiddenError.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -76,14 +134,14 @@ File
Description
-
```html
+ Example :```html
Extends
- HttpException
+ HttpException
diff --git a/classes/HttpUnauthorizedError.html b/classes/HttpUnauthorizedError.html
index b2f8fcf4..27cf9ef5 100644
--- a/classes/HttpUnauthorizedError.html
+++ b/classes/HttpUnauthorizedError.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -76,14 +134,14 @@ File
Description
-
```html
+ Example :```html
Extends
- UnauthorizedException
+ UnauthorizedException
diff --git a/classes/KeyValueModel.html b/classes/KeyValueModel.html
index b969cc92..e66c9c65 100644
--- a/classes/KeyValueModel.html
+++ b/classes/KeyValueModel.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/KeywordQueryDTO.html b/classes/KeywordQueryDTO.html
index bccfc477..1cab2524 100644
--- a/classes/KeywordQueryDTO.html
+++ b/classes/KeywordQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/Option.html b/classes/Option.html
index 6a24f84d..9abdda51 100644
--- a/classes/Option.html
+++ b/classes/Option.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/PaginateBaseOptionDTO.html b/classes/PaginateBaseOptionDTO.html
index 6a004fd4..6e81c7fb 100644
--- a/classes/PaginateBaseOptionDTO.html
+++ b/classes/PaginateBaseOptionDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/PaginateOptionDTO.html b/classes/PaginateOptionDTO.html
index bd31024a..b7797e94 100644
--- a/classes/PaginateOptionDTO.html
+++ b/classes/PaginateOptionDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- PaginateBaseOptionDTO
+ PaginateBaseOptionDTO
diff --git a/classes/PaginateOptionWithHotSortDTO.html b/classes/PaginateOptionWithHotSortDTO.html
index 16f82bd8..9213bf1a 100644
--- a/classes/PaginateOptionWithHotSortDTO.html
+++ b/classes/PaginateOptionWithHotSortDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- PaginateBaseOptionDTO
+ PaginateBaseOptionDTO
diff --git a/classes/PostVoteDTO.html b/classes/PostVoteDTO.html
index 95dafdc8..2132cb96 100644
--- a/classes/PostVoteDTO.html
+++ b/classes/PostVoteDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- VoteAuthorDTO
+ VoteAuthorDTO
diff --git a/classes/Tag.html b/classes/Tag.html
index 20c6b51b..6325f51e 100644
--- a/classes/Tag.html
+++ b/classes/Tag.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -455,13 +513,13 @@
import { AutoIncrementID } from '@typegoose/auto-increment'
import { prop, plugin, modelOptions } from '@typegoose/typegoose'
import { IsString, MaxLength, Matches, IsNotEmpty, IsArray, ArrayUnique } from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { KeyValueModel } from '@app/models/key-value.model'
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
schemaOptions: {
versionKey: false,
diff --git a/classes/TagPaginateQueryDTO.html b/classes/TagPaginateQueryDTO.html
index 26bad7de..9968112d 100644
--- a/classes/TagPaginateQueryDTO.html
+++ b/classes/TagPaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -73,6 +131,12 @@ File
+
+
Extends
+
+
+ IntersectionType(PaginateOptionDTO, KeywordQueryDTO)
+
diff --git a/classes/TagsDTO.html b/classes/TagsDTO.html
index 32c08a36..52ab1311 100644
--- a/classes/TagsDTO.html
+++ b/classes/TagsDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/ThreadPostIdDTO.html b/classes/ThreadPostIdDTO.html
index baf3aaec..1a01298e 100644
--- a/classes/ThreadPostIdDTO.html
+++ b/classes/ThreadPostIdDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/ValidationError.html b/classes/ValidationError.html
index 7edf20f9..d07988d4 100644
--- a/classes/ValidationError.html
+++ b/classes/ValidationError.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -76,14 +134,14 @@ File
Description
-
```html
+ Example :```html
Extends
- HttpException
+ HttpException
diff --git a/classes/Vote.html b/classes/Vote.html
index 74a2e091..575750d6 100644
--- a/classes/Vote.html
+++ b/classes/Vote.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -598,7 +656,7 @@
import { AutoIncrementID } from '@typegoose/auto-increment'
import { prop, plugin, modelOptions, Severity } from '@typegoose/typegoose'
import { IsString, IsIP, IsIn, IsInt, IsOptional, IsNotEmpty } from 'class-validator'
-import { generalAutoIncrementIDConfig } from '@app/constants/increment.constant'
+import { GENERAL_AUTO_INCREMENT_ID_CONFIG } from '@app/constants/increment.constant'
import { getProviderByTypegooseClass } from '@app/transformers/model.transformer'
import { mongoosePaginate } from '@app/utils/paginate'
import { IPLocation } from '@app/processors/helper/helper.service.ip'
@@ -629,7 +687,7 @@
export const VOTE_AUTHOR_TYPES = [VoteAuthorType.Anonymous, VoteAuthorType.Guest, VoteAuthorType.Disqus] as const
@plugin(mongoosePaginate)
-@plugin(AutoIncrementID, generalAutoIncrementIDConfig)
+@plugin(AutoIncrementID, GENERAL_AUTO_INCREMENT_ID_CONFIG)
@modelOptions({
options: { allowMixed: Severity.ALLOW },
schemaOptions: {
diff --git a/classes/VoteAuthorDTO.html b/classes/VoteAuthorDTO.html
index cb94b79c..5bcbef8d 100644
--- a/classes/VoteAuthorDTO.html
+++ b/classes/VoteAuthorDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/classes/VotePaginateQueryDTO.html b/classes/VotePaginateQueryDTO.html
index bd2ea57d..19038c5d 100644
--- a/classes/VotePaginateQueryDTO.html
+++ b/classes/VotePaginateQueryDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -77,7 +135,7 @@ File
Extends
- PaginateOptionDTO
+ PaginateOptionDTO
diff --git a/classes/VotesDTO.html b/classes/VotesDTO.html
index f721349e..81d1159c 100644
--- a/classes/VotesDTO.html
+++ b/classes/VotesDTO.html
@@ -12,6 +12,64 @@
+
NodePress documentation
diff --git a/controllers/AnnouncementController.html b/controllers/AnnouncementController.html
index ef2f795e..e578f318 100644
--- a/controllers/AnnouncementController.html
+++ b/controllers/AnnouncementController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -143,9 +201,9 @@
-
-
-
+
+
+
createAnnouncement
@@ -153,7 +211,7 @@
-
+
createAnnouncement(announcement: Announcement)
@@ -166,53 +224,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- announcement
-
- Announcement
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ announcement
+
+ Announcement
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -223,9 +279,9 @@
-
-
-
+
+
+
delAnnouncement
@@ -233,7 +289,7 @@
-
+
delAnnouncement(undefined: QueryParamsResult)
@@ -246,52 +302,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -302,9 +356,9 @@
-
-
-
+
+
+
delAnnouncements
@@ -312,7 +366,7 @@
-
+
delAnnouncements(body: AnnouncementsDTO)
@@ -325,53 +379,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- AnnouncementsDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ AnnouncementsDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -382,10 +434,10 @@
-
-
-
-
+
+
+
+
getAnnouncements
@@ -393,7 +445,7 @@
-
+
getAnnouncements(query: AnnouncementPaginateQueryDTO)
@@ -406,53 +458,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- AnnouncementPaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Announcement>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ AnnouncementPaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Announcement>>
+
+
+
+
+
@@ -463,9 +513,9 @@
-
-
-
+
+
+
putAnnouncement
@@ -473,7 +523,7 @@
-
+
putAnnouncement(undefined: QueryParamsResult, announcement: Announcement)
@@ -486,64 +536,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- announcement
-
- Announcement
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ announcement
+
+ Announcement
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/controllers/AppController.html b/controllers/AppController.html
index d8ff5efe..1648c765 100644
--- a/controllers/AppController.html
+++ b/controllers/AppController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -110,7 +168,7 @@
-
+
root
@@ -118,7 +176,7 @@
-
+
root()
@@ -131,21 +189,21 @@
-
-
- Defined in src/app.controller.ts:13
-
-
+
+
+ Defined in src/app.controller.ts:13
+
+
-
diff --git a/controllers/ArchiveController.html b/controllers/ArchiveController.html
index 13502cf9..ee48bd53 100644
--- a/controllers/ArchiveController.html
+++ b/controllers/ArchiveController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -123,8 +181,8 @@
-
-
+
+
getArchive
@@ -132,7 +190,7 @@
-
+
getArchive()
@@ -145,21 +203,21 @@
-
-
- Defined in src/modules/archive/archive.controller.ts:18
-
-
+
+
+ Defined in src/modules/archive/archive.controller.ts:18
+
+
-
- Returns : Promise<ArchiveData>
+
+ Returns : Promise<ArchiveData>
-
+
@@ -170,9 +228,9 @@
-
-
-
+
+
+
updateArchive
@@ -180,7 +238,7 @@
-
+
updateArchive()
@@ -193,21 +251,21 @@
-
-
- Defined in src/modules/archive/archive.controller.ts:25
-
-
+
+
+ Defined in src/modules/archive/archive.controller.ts:25
+
+
-
- Returns : Promise<any>
+
+ Returns : Promise<any>
-
+
diff --git a/controllers/ArticleController.html b/controllers/ArticleController.html
index 652533ae..04fbc57c 100644
--- a/controllers/ArticleController.html
+++ b/controllers/ArticleController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -168,9 +226,9 @@
-
-
-
+
+
+
createArticle
@@ -178,7 +236,7 @@
-
+
createArticle(article: Article)
@@ -191,53 +249,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- article
-
- Article
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Article>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ article
+
+ Article
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Article>
+
+
+
+
+
@@ -248,9 +304,9 @@
-
-
-
+
+
+
delArticle
@@ -258,7 +314,7 @@
-
+
delArticle(undefined: QueryParamsResult)
@@ -271,52 +327,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Article>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Article>
+
+
+
+
+
@@ -327,9 +381,9 @@
-
-
-
+
+
+
delArticles
@@ -337,7 +391,7 @@
-
+
delArticles(body: ArticleIDsDTO)
@@ -350,53 +404,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- ArticleIDsDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ ArticleIDsDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -407,9 +459,9 @@
-
-
-
+
+
+
getArticle
@@ -417,7 +469,7 @@
-
+
getArticle(undefined: QueryParamsResult)
@@ -430,52 +482,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Article>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Article>
+
+
+
+
+
@@ -486,9 +536,9 @@
-
-
-
+
+
+
getArticleCalendar
@@ -496,7 +546,7 @@
-
+
getArticleCalendar(query: ArticleCalendarQueryDTO, undefined: QueryParamsResult)
@@ -509,64 +559,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- ArticleCalendarQueryDTO
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ ArticleCalendarQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -577,9 +625,9 @@
-
-
- Async
+
+
+ Async
getArticleContext
@@ -587,7 +635,7 @@
-
+
getArticleContext(undefined: QueryParamsResult)
@@ -600,52 +648,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
@@ -656,11 +702,11 @@
-
-
-
-
- Async
+
+
+
+
+ Async
getArticles
@@ -668,7 +714,7 @@
-
+
getArticles(query: ArticlePaginateQueryDTO)
@@ -681,53 +727,51 @@
-
-
- Defined in src/modules/article/article.controller.ts:37
-
-
+
+
+ Defined in src/modules/article/article.controller.ts:37
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- ArticlePaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Article>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ ArticlePaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Article>>
+
+
+
+
+
@@ -738,9 +782,9 @@
-
-
-
+
+
+
patchArticles
@@ -748,7 +792,7 @@
-
+
patchArticles(body: ArticlesStateDTO)
@@ -761,53 +805,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- ArticlesStateDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ ArticlesStateDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -818,9 +860,9 @@
-
-
-
+
+
+
putArticle
@@ -828,7 +870,7 @@
-
+
putArticle(undefined: QueryParamsResult, article: Article)
@@ -841,64 +883,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- article
-
- Article
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Article>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ article
+
+ Article
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Article>
+
+
+
+
+
diff --git a/controllers/AuthController.html b/controllers/AuthController.html
index f795dec6..589cdfec 100644
--- a/controllers/AuthController.html
+++ b/controllers/AuthController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -141,9 +199,9 @@
-
-
-
+
+
+
checkToken
@@ -151,7 +209,7 @@
-
+
checkToken()
@@ -164,21 +222,21 @@
-
-
- Defined in src/modules/auth/auth.controller.ts:67
-
-
+
+
+ Defined in src/modules/auth/auth.controller.ts:67
+
+
-
@@ -189,8 +247,8 @@
-
-
+
+
getAdminInfo
@@ -198,7 +256,7 @@
-
+
getAdminInfo()
@@ -211,21 +269,21 @@
-
-
- Defined in src/modules/auth/auth.controller.ts:52
-
-
+
+
+ Defined in src/modules/auth/auth.controller.ts:52
+
+
-
- Returns : Promise<Auth>
+
+ Returns : Promise<Auth>
-
+
@@ -236,9 +294,9 @@
-
-
- Async
+
+
+ Async
login
@@ -246,7 +304,7 @@
-
+
login(undefined: QueryParamsResult, body: AuthLoginDTO)
@@ -259,64 +317,62 @@
-
-
- Defined in src/modules/auth/auth.controller.ts:29
-
-
+
+
+ Defined in src/modules/auth/auth.controller.ts:29
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- body
-
- AuthLoginDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<TokenResult>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ body
+
+ AuthLoginDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<TokenResult>
+
+
+
+
+
@@ -327,9 +383,9 @@
-
-
-
+
+
+
putAdminInfo
@@ -337,7 +393,7 @@
-
+
putAdminInfo(auth: AuthUpdateDTO)
@@ -350,53 +406,51 @@
-
-
- Defined in src/modules/auth/auth.controller.ts:59
-
-
+
+
+ Defined in src/modules/auth/auth.controller.ts:59
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- auth
-
- AuthUpdateDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Auth>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ auth
+
+ AuthUpdateDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Auth>
+
+
+
+
+
@@ -407,9 +461,9 @@
-
-
-
+
+
+
renewalToken
@@ -417,7 +471,7 @@
-
+
renewalToken()
@@ -430,21 +484,21 @@
-
-
- Defined in src/modules/auth/auth.controller.ts:75
-
-
+
+
+ Defined in src/modules/auth/auth.controller.ts:75
+
+
-
- Returns : TokenResult
+
+ Returns : TokenResult
-
+
diff --git a/controllers/CategoryController.html b/controllers/CategoryController.html
index 8327a3db..4d6e9ef3 100644
--- a/controllers/CategoryController.html
+++ b/controllers/CategoryController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -148,9 +206,9 @@
-
-
-
+
+
+
createCategory
@@ -158,7 +216,7 @@
-
+
createCategory(category: Category)
@@ -171,53 +229,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- category
-
- Category
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Category>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ category
+
+ Category
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Category>
+
+
+
+
+
@@ -228,9 +284,9 @@
-
-
-
+
+
+
delCategories
@@ -238,7 +294,7 @@
-
+
delCategories(body: CategoriesDTO)
@@ -251,53 +307,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- CategoriesDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ CategoriesDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -308,9 +362,9 @@
-
-
-
+
+
+
delCategory
@@ -318,7 +372,7 @@
-
+
delCategory(undefined: QueryParamsResult)
@@ -331,52 +385,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -387,10 +439,10 @@
-
-
-
-
+
+
+
+
getCategories
@@ -398,7 +450,7 @@
-
+
getCategories(query: CategoryPaginateQueryDTO, undefined: QueryParamsResult)
@@ -411,64 +463,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- CategoryPaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Category>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ CategoryPaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Category>>
+
+
+
+
+
@@ -479,8 +529,8 @@
-
-
+
+
getCategory
@@ -488,7 +538,7 @@
-
+
getCategory(undefined: QueryParamsResult)
@@ -501,52 +551,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Category[]>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Category[]>
+
+
+
+
+
@@ -557,9 +605,9 @@
-
-
-
+
+
+
putCategory
@@ -567,7 +615,7 @@
-
+
putCategory(undefined: QueryParamsResult, category: Category)
@@ -580,64 +628,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- category
-
- Category
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Category>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ category
+
+ Category
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Category>
+
+
+
+
+
diff --git a/controllers/CommentController.html b/controllers/CommentController.html
index 9c6b1555..f1a13617 100644
--- a/controllers/CommentController.html
+++ b/controllers/CommentController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -167,9 +225,9 @@
-
-
-
+
+
+
createComment
@@ -177,7 +235,7 @@
-
+
createComment(comment: CommentBase, undefined: QueryParamsResult)
@@ -190,64 +248,62 @@
-
-
- Defined in src/modules/comment/comment.controller.ts:84
-
-
+
+
+ Defined in src/modules/comment/comment.controller.ts:84
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- comment
-
- CommentBase
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Comment>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ comment
+
+ CommentBase
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Comment>
+
+
+
+
+
@@ -258,9 +314,9 @@
-
-
-
+
+
+
delComment
@@ -268,7 +324,7 @@
-
+
delComment(undefined: QueryParamsResult)
@@ -281,52 +337,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -337,9 +391,9 @@
-
-
-
+
+
+
delComments
@@ -347,7 +401,7 @@
-
+
delComments(body: CommentsDTO)
@@ -360,53 +414,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- CommentsDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ CommentsDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -417,9 +469,9 @@
-
-
-
+
+
+
getComment
@@ -427,7 +479,7 @@
-
+
getComment(undefined: QueryParamsResult)
@@ -440,52 +492,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Comment>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Comment>
+
+
+
+
+
@@ -496,9 +546,9 @@
-
-
-
+
+
+
getCommentCalendar
@@ -506,7 +556,7 @@
-
+
getCommentCalendar(query: CommentCalendarQueryDTO, undefined: QueryParamsResult)
@@ -519,64 +569,62 @@
-
-
- Defined in src/modules/comment/comment.controller.ts:74
-
-
+
+
+ Defined in src/modules/comment/comment.controller.ts:74
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- CommentCalendarQueryDTO
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ CommentCalendarQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -587,10 +635,10 @@
-
-
-
-
+
+
+
+
getComments
@@ -598,7 +646,7 @@
-
+
getComments(query: CommentPaginateQueryDTO, undefined: QueryParamsResult)
@@ -611,64 +659,62 @@
-
-
- Defined in src/modules/comment/comment.controller.ts:30
-
-
+
+
+ Defined in src/modules/comment/comment.controller.ts:30
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- CommentPaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Comment>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ CommentPaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Comment>>
+
+
+
+
+
@@ -679,9 +725,9 @@
-
-
-
+
+
+
patchComments
@@ -689,7 +735,7 @@
-
+
patchComments(undefined: QueryParamsResult, body: CommentsStateDTO)
@@ -702,64 +748,62 @@
-
-
- Defined in src/modules/comment/comment.controller.ts:93
-
-
+
+
+ Defined in src/modules/comment/comment.controller.ts:93
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- body
-
- CommentsStateDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ body
+
+ CommentsStateDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -770,9 +814,9 @@
-
-
-
+
+
+
putComment
@@ -780,7 +824,7 @@
-
+
putComment(undefined: QueryParamsResult, comment: Comment)
@@ -793,64 +837,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- comment
-
- Comment
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Comment>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ comment
+
+ Comment
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Comment>
+
+
+
+
+
@@ -861,9 +903,9 @@
-
-
-
+
+
+
putCommentIPLocation
@@ -871,7 +913,7 @@
-
+
putCommentIPLocation(undefined: QueryParamsResult)
@@ -884,52 +926,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/controllers/DisqusController.html b/controllers/DisqusController.html
index a2bf0fe3..c06d9b69 100644
--- a/controllers/DisqusController.html
+++ b/controllers/DisqusController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -189,9 +247,9 @@
-
-
-
+
+
+
createComment
@@ -199,7 +257,7 @@
-
+
createComment(undefined: QueryParamsResult, token: AccessToken | null, comment: CommentBase)
@@ -212,76 +270,74 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:108
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:108
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- token
-
- AccessToken | null
-
-
-
- No
-
-
-
-
-
- comment
-
- CommentBase
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ token
+
+ AccessToken | null
+
+
+
+ No
+
+
+
+
+
+ comment
+
+ CommentBase
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -292,8 +348,8 @@
-
-
+
+
deleteComment
@@ -301,7 +357,7 @@
-
+
deleteComment(payload: CommentIdDTO, token: AccessToken | null)
@@ -314,65 +370,63 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:118
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:118
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- CommentIdDTO
-
-
-
- No
-
-
-
-
-
- token
-
- AccessToken | null
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ CommentIdDTO
+
+
+
+ No
+
+
+
+
+
+ token
+
+ AccessToken | null
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -383,9 +437,9 @@
-
-
-
+
+
+
exportXML
@@ -393,7 +447,7 @@
-
+
exportXML(response)
@@ -406,49 +460,47 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:158
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:158
+
+
-
- Parameters :
-
-
-
-
- Name
- Optional
-
-
-
-
- response
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Optional
+
+
+
+
+ response
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -459,8 +511,8 @@
-
-
+
+
getConfig
@@ -468,7 +520,7 @@
-
+
getConfig()
@@ -481,21 +533,21 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:46
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:46
+
+
-
- Returns : { forum: any; admin_username: any; public_key: any; authorize_url: any; }
+
+ Returns : { forum: any; admin_username: any; public_key: any; authorize_url: any; }
-
+
@@ -506,9 +558,9 @@
-
-
-
+
+
+
getPosts
@@ -516,7 +568,7 @@
-
+
getPosts(query: GeneralDisqusParams)
@@ -529,53 +581,51 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:137
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:137
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- GeneralDisqusParams
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ GeneralDisqusParams
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -586,8 +636,8 @@
-
-
+
+
getThread
@@ -595,7 +645,7 @@
-
+
getThread(query: ThreadPostIdDTO)
@@ -608,53 +658,51 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:101
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:101
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- ThreadPostIdDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ ThreadPostIdDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -665,9 +713,9 @@
-
-
-
+
+
+
getThreads
@@ -675,7 +723,7 @@
-
+
getThreads(query: GeneralDisqusParams)
@@ -688,53 +736,51 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:130
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:130
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- GeneralDisqusParams
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ GeneralDisqusParams
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -745,8 +791,8 @@
-
-
+
+
getUserInfo
@@ -754,7 +800,7 @@
-
+
getUserInfo(token: AccessToken | null)
@@ -767,53 +813,51 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:89
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:89
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- token
-
- AccessToken | null
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ token
+
+ AccessToken | null
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -824,10 +868,10 @@
-
-
-
-
+
+
+
+
importXML
@@ -835,7 +879,7 @@
-
+
importXML(file: Express.Multer.File)
@@ -848,53 +892,51 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:169
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:169
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- file
-
- Express.Multer.File
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ file
+
+ Express.Multer.File
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -905,11 +947,11 @@
-
-
-
-
- Async
+
+
+
+
+ Async
oauthCallback
@@ -917,7 +959,7 @@
-
+
oauthCallback(query: CallbackCodeDTO, response)
@@ -930,64 +972,62 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:59
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:59
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- CallbackCodeDTO
-
-
-
- No
-
-
-
-
-
- response
-
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ CallbackCodeDTO
+
+
+
+ No
+
+
+
+
+
+ response
+
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -998,9 +1038,9 @@
-
-
-
+
+
+
oauthLogout
@@ -1008,7 +1048,7 @@
-
+
oauthLogout(token: AccessToken | null, response)
@@ -1021,64 +1061,62 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:79
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:79
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- token
-
- AccessToken | null
-
-
-
- No
-
-
-
-
-
- response
-
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : void
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ token
+
+ AccessToken | null
+
+
+
+ No
+
+
+
+
+
+ response
+
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : void
+
+
+
+
+
@@ -1089,9 +1127,9 @@
-
-
-
+
+
+
updatePost
@@ -1099,7 +1137,7 @@
-
+
updatePost(body)
@@ -1112,49 +1150,47 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:144
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:144
+
+
-
- Parameters :
-
-
-
-
- Name
- Optional
-
-
-
-
- body
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Optional
+
+
+
+
+ body
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -1165,9 +1201,9 @@
-
-
-
+
+
+
updateThread
@@ -1175,7 +1211,7 @@
-
+
updateThread(body)
@@ -1188,49 +1224,47 @@
-
-
- Defined in src/modules/disqus/disqus.controller.ts:151
-
-
+
+
+ Defined in src/modules/disqus/disqus.controller.ts:151
+
+
-
- Parameters :
-
-
-
-
- Name
- Optional
-
-
-
-
- body
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Optional
+
+
+
+
+ body
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/controllers/ExpansionController.html b/controllers/ExpansionController.html
index 61957f6d..3fc78df6 100644
--- a/controllers/ExpansionController.html
+++ b/controllers/ExpansionController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -137,9 +195,9 @@
-
-
-
+
+
+
getGoogleToken
@@ -147,7 +205,7 @@
-
+
getGoogleToken()
@@ -160,21 +218,21 @@
-
-
-
-
-
+
+
+
+
+
-
- Returns : Promise<Auth.Credentials>
+
+ Returns : Promise<Auth.Credentials>
-
+
@@ -185,9 +243,9 @@
-
-
-
+
+
+
getSystemStatistics
@@ -195,7 +253,7 @@
-
+
getSystemStatistics(undefined: QueryParamsResult)
@@ -208,52 +266,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Statistic>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Statistic>
+
+
+
+
+
@@ -264,9 +320,9 @@
-
-
-
+
+
+
updateDatabaseBackup
@@ -274,7 +330,7 @@
-
+
updateDatabaseBackup()
@@ -287,21 +343,21 @@
-
-
-
-
-
+
+
+
+
+
-
@@ -312,10 +368,10 @@
-
-
-
-
+
+
+
+
uploadStatic
@@ -323,7 +379,7 @@
-
+
uploadStatic(file: Express.Multer.File, body)
@@ -336,64 +392,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- file
-
- Express.Multer.File
-
-
-
- No
-
-
-
-
-
- body
-
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ file
+
+ Express.Multer.File
+
+
+
+ No
+
+
+
+
+
+ body
+
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/controllers/FeedbackController.html b/controllers/FeedbackController.html
index 53791de1..f31f0997 100644
--- a/controllers/FeedbackController.html
+++ b/controllers/FeedbackController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -144,10 +202,10 @@
-
-
-
- Async
+
+
+
+ Async
createFeedback
@@ -155,7 +213,7 @@
-
+
createFeedback(feedback: FeedbackBase, undefined: QueryParamsResult)
@@ -168,64 +226,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- feedback
-
- FeedbackBase
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Feedback>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ feedback
+
+ FeedbackBase
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Feedback>
+
+
+
+
+
@@ -236,9 +292,9 @@
-
-
-
+
+
+
deleteFeedback
@@ -246,7 +302,7 @@
-
+
deleteFeedback(undefined: QueryParamsResult)
@@ -259,52 +315,50 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -315,9 +369,9 @@
-
-
-
+
+
+
deleteFeedbacks
@@ -325,7 +379,7 @@
-
+
deleteFeedbacks(body: FeedbacksDTO)
@@ -338,53 +392,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- FeedbacksDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ FeedbacksDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -395,10 +447,10 @@
-
-
-
-
+
+
+
+
getFeedbacks
@@ -406,7 +458,7 @@
-
+
getFeedbacks(query: FeedbackPaginateQueryDTO)
@@ -419,53 +471,51 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- FeedbackPaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Feedback>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ FeedbackPaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Feedback>>
+
+
+
+
+
@@ -476,9 +526,9 @@
-
-
-
+
+
+
putFeedback
@@ -486,7 +536,7 @@
-
+
putFeedback(undefined: QueryParamsResult, feedback: Feedback)
@@ -499,64 +549,62 @@
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- feedback
-
- Feedback
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Feedback>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ feedback
+
+ Feedback
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Feedback>
+
+
+
+
+
diff --git a/controllers/OptionController.html b/controllers/OptionController.html
index eeff2b98..0ede337f 100644
--- a/controllers/OptionController.html
+++ b/controllers/OptionController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -124,9 +182,9 @@
-
-
-
+
+
+
getOption
@@ -134,7 +192,7 @@
-
+
getOption(undefined: QueryParamsResult)
@@ -147,52 +205,50 @@
-
-
- Defined in src/modules/option/option.controller.ts:22
-
-
+
+
+ Defined in src/modules/option/option.controller.ts:22
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -203,9 +259,9 @@
-
-
-
+
+
+
putOption
@@ -213,7 +269,7 @@
-
+
putOption(option: Option)
@@ -226,53 +282,51 @@
-
-
- Defined in src/modules/option/option.controller.ts:29
-
-
+
+
+ Defined in src/modules/option/option.controller.ts:29
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- option
-
- Option
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Option>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ option
+
+ Option
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Option>
+
+
+
+
+
diff --git a/controllers/TagController.html b/controllers/TagController.html
index 5d534d4c..83492563 100644
--- a/controllers/TagController.html
+++ b/controllers/TagController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -148,9 +206,9 @@
-
-
-
+
+
+
createTag
@@ -158,7 +216,7 @@
-
+
createTag(tag: Tag)
@@ -171,53 +229,51 @@
-
-
- Defined in src/modules/tag/tag.controller.ts:56
-
-
+
+
+ Defined in src/modules/tag/tag.controller.ts:56
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- tag
-
- Tag
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Tag>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ tag
+
+ Tag
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Tag>
+
+
+
+
+
@@ -228,9 +284,9 @@
-
-
-
+
+
+
delTag
@@ -238,7 +294,7 @@
-
+
delTag(undefined: QueryParamsResult)
@@ -251,52 +307,50 @@
-
-
- Defined in src/modules/tag/tag.controller.ts:77
-
-
+
+
+ Defined in src/modules/tag/tag.controller.ts:77
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Tag>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Tag>
+
+
+
+
+
@@ -307,9 +361,9 @@
-
-
-
+
+
+
delTags
@@ -317,7 +371,7 @@
-
+
delTags(body: TagsDTO)
@@ -330,53 +384,51 @@
-
-
- Defined in src/modules/tag/tag.controller.ts:63
-
-
+
+
+ Defined in src/modules/tag/tag.controller.ts:63
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- TagsDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ TagsDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -387,8 +439,8 @@
-
-
+
+
getAllTags
@@ -396,7 +448,7 @@
-
+
getAllTags()
@@ -409,21 +461,21 @@
-
-
- Defined in src/modules/tag/tag.controller.ts:49
-
-
+
+
+ Defined in src/modules/tag/tag.controller.ts:49
+
+
-
- Returns : Promise<Array<Tag>>
+
+ Returns : Promise<Array<Tag>>
-
+
@@ -434,10 +486,10 @@
-
-
-
-
+
+
+
+
getTags
@@ -445,7 +497,7 @@
-
+
getTags(query: TagPaginateQueryDTO, undefined: QueryParamsResult)
@@ -458,64 +510,62 @@
-
-
- Defined in src/modules/tag/tag.controller.ts:28
-
-
+
+
+ Defined in src/modules/tag/tag.controller.ts:28
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- TagPaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Tag>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ TagPaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Tag>>
+
+
+
+
+
@@ -526,9 +576,9 @@
-
-
-
+
+
+
putTag
@@ -536,7 +586,7 @@
-
+
putTag(undefined: QueryParamsResult, tag: Tag)
@@ -549,64 +599,62 @@
-
-
- Defined in src/modules/tag/tag.controller.ts:70
-
-
+
+
+ Defined in src/modules/tag/tag.controller.ts:70
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
- tag
-
- Tag
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<Tag>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+ tag
+
+ Tag
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<Tag>
+
+
+
+
+
diff --git a/controllers/VoteController.html b/controllers/VoteController.html
index e9aedd75..c3430518 100644
--- a/controllers/VoteController.html
+++ b/controllers/VoteController.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -166,9 +224,9 @@
-
-
-
+
+
+
deleteVotes
@@ -176,7 +234,7 @@
-
+
deleteVotes(body: VotesDTO)
@@ -189,53 +247,51 @@
-
-
- Defined in src/modules/vote/vote.controller.ts:193
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:193
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- body
-
- VotesDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ body
+
+ VotesDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -246,7 +302,7 @@
- Private
+ Private
emailToTargetVoteMessage
@@ -254,59 +310,57 @@
-
+
emailToTargetVoteMessage(payload: literal type)
-
-
- Defined in src/modules/vote/vote.controller.ts:110
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:110
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- literal type
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : void
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ literal type
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : void
+
+
+
+
+
@@ -317,7 +371,7 @@
- Private
+ Private
getAuthorString
@@ -325,59 +379,57 @@
-
+
getAuthorString(voteAuthor: literal type)
-
-
- Defined in src/modules/vote/vote.controller.ts:91
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:91
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- voteAuthor
-
- literal type
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ voteAuthor
+
+ literal type
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -388,8 +440,8 @@
- Private
- Async
+ Private
+ Async
getPostTitle
@@ -397,59 +449,57 @@
-
+
getPostTitle(postId: number)
-
-
- Defined in src/modules/vote/vote.controller.ts:48
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:48
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- postId
-
- number
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ postId
+
+ number
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
@@ -460,8 +510,8 @@
- Private
- Async
+ Private
+ Async
getVoteAuthor
@@ -469,59 +519,57 @@
-
+
getVoteAuthor(payload: literal type)
-
-
- Defined in src/modules/vote/vote.controller.ts:57
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:57
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- literal type
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ literal type
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
@@ -532,10 +580,10 @@
-
-
-
-
+
+
+
+
getVotes
@@ -543,7 +591,7 @@
-
+
getVotes(query: VotePaginateQueryDTO)
@@ -556,53 +604,51 @@
-
-
- Defined in src/modules/vote/vote.controller.ts:167
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:167
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- query
-
- VotePaginateQueryDTO
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<PaginateResult<Vote>>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ query
+
+ VotePaginateQueryDTO
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<PaginateResult<Vote>>
+
+
+
+
+
@@ -613,8 +659,8 @@
- Private
- Async
+ Private
+ Async
queryIPLocation
@@ -622,59 +668,57 @@
-
+
queryIPLocation(ip: string | null)
-
-
- Defined in src/modules/vote/vote.controller.ts:44
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:44
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- ip
-
- string | null
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ ip
+
+ string | null
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
@@ -685,10 +729,10 @@
-
-
-
- Async
+
+
+
+ Async
voteComment
@@ -696,7 +740,7 @@
-
+
voteComment(voteBody: CommentVoteDTO, token: AccessToken | null, undefined: QueryParamsResult)
@@ -709,76 +753,74 @@
-
-
- Defined in src/modules/vote/vote.controller.ts:248
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:248
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- voteBody
-
- CommentVoteDTO
-
-
-
- No
-
-
-
-
-
- token
-
- AccessToken | null
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ voteBody
+
+ CommentVoteDTO
+
+
+
+ No
+
+
+
+
+
+ token
+
+ AccessToken | null
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
@@ -789,7 +831,7 @@
- Async
+ Async
voteDisqusThread
@@ -797,83 +839,81 @@
-
+
voteDisqusThread(postId: number, vote: number, token?: string)
-
-
- Defined in src/modules/vote/vote.controller.ts:152
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:152
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- postId
-
- number
-
-
-
- No
-
-
-
-
-
- vote
-
- number
-
-
-
- No
-
-
-
-
-
- token
-
- string
-
-
-
- Yes
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ postId
+
+ number
+
+
+
+ No
+
+
+
+
+
+ vote
+
+ number
+
+
+
+ No
+
+
+
+
+
+ token
+
+ string
+
+
+
+ Yes
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
@@ -884,10 +924,10 @@
-
-
-
- Async
+
+
+
+ Async
votePost
@@ -895,7 +935,7 @@
-
+
votePost(voteBody: PostVoteDTO, token: AccessToken | null, undefined: QueryParamsResult)
@@ -908,76 +948,74 @@
-
-
- Defined in src/modules/vote/vote.controller.ts:200
-
-
+
+
+ Defined in src/modules/vote/vote.controller.ts:200
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- voteBody
-
- PostVoteDTO
-
-
-
- No
-
-
-
-
-
- token
-
- AccessToken | null
-
-
-
- No
-
-
-
-
-
-
- QueryParamsResult
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : unknown
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ voteBody
+
+ PostVoteDTO
+
+
+
+ No
+
+
+
+
+
+ token
+
+ AccessToken | null
+
+
+
+ No
+
+
+
+
+
+
+ QueryParamsResult
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : unknown
+
+
+
+
+
diff --git a/dependencies.html b/dependencies.html
index 2e2d10a7..49a1860d 100644
--- a/dependencies.html
+++ b/dependencies.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -50,31 +108,31 @@
-
- @aws-sdk/client-s3 : ^3.427.0
+ @aws-sdk/client-s3 : ^3.458.0
-
- @nestjs/axios : ^3.0.0
+ @nestjs/axios : ^3.0.1
-
- @nestjs/common : ^10.2.7
+ @nestjs/common : ^10.2.10
-
- @nestjs/core : ^10.2.7
+ @nestjs/core : ^10.2.10
-
- @nestjs/jwt : ^10.1.1
+ @nestjs/jwt : ^10.2.0
-
- @nestjs/mapped-types : ^2.0.2
+ @nestjs/mapped-types : ^2.0.4
-
@nestjs/passport : ^10.0.2
-
- @nestjs/platform-express : ^10.2.7
+ @nestjs/platform-express : ^10.2.10
-
- @nestjs/throttler : ^5.0.0
+ @nestjs/throttler : ^5.0.1
-
- @typegoose/auto-increment : ^3.5.0
+ @typegoose/auto-increment : ^4.0.0
-
- @typegoose/typegoose : ^11.5.1
+ @typegoose/typegoose : ^12.0.0
-
akismet-api : ^6.0.0
-
- axios : ^1.5.1
+ axios : ^1.6.2
-
body-parser : ^1.20.2
-
@@ -96,9 +154,9 @@
-
fast-xml-parser : ^4.3.2
-
- googleapis : ^126.0.1
+ googleapis : ^128.0.0
-
- helmet : ^7.0.0
+ helmet : ^7.1.0
-
js-base64 : ^3.7.5
-
@@ -106,17 +164,17 @@
-
lodash : ^4.17.21
-
- mongoose : ~7.5.0
+ mongoose : ~8.0.1
-
node-schedule : ^2.1.1
-
- nodemailer : ^6.9.5
+ nodemailer : ^6.9.7
-
passport : ~0.6.0
-
passport-jwt : ^4.0.1
-
- redis : ^4.6.10
+ redis : ^4.6.11
-
reflect-metadata : ^0.1.13
-
@@ -126,7 +184,7 @@
-
shelljs : ^0.8.5
-
- ua-parser-js : ^1.0.36
+ ua-parser-js : ^1.0.37
-
yargs : ^17.7.2
diff --git a/index.html b/index.html
index 77a9397a..ff436cd7 100644
--- a/index.html
+++ b/index.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -64,7 +122,7 @@ NodePress
Development
-$ pnpm install
+Example :$ pnpm install
# dev
$ pnpm run start:dev
diff --git a/injectables/AWSService.html b/injectables/AWSService.html
index 85aea78f..3141017f 100644
--- a/injectables/AWSService.html
+++ b/injectables/AWSService.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -120,7 +178,7 @@
- Private
+ Private
createClient
@@ -128,59 +186,57 @@
-
+
createClient(region: string)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- region
-
- string
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ region
+
+ string
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -191,7 +247,7 @@
- Public
+ Public
getObjectAttributes
@@ -199,59 +255,57 @@
-
+
getObjectAttributes(payload: literal type)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- literal type
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ literal type
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -262,7 +316,7 @@
- Public
+ Public
uploadFile
@@ -270,59 +324,57 @@
-
+
uploadFile(payload: FileUploader)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- FileUploader
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<UploadResult>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ FileUploader
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<UploadResult>
+
+
+
+
+
diff --git a/injectables/AdminMaybeGuard.html b/injectables/AdminMaybeGuard.html
index 3c047ecd..b2bfad64 100644
--- a/injectables/AdminMaybeGuard.html
+++ b/injectables/AdminMaybeGuard.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -72,9 +130,15 @@ File
Description
-
+ Example :
+
+
Extends
+
+
+ AuthGuard('jwt')
+
@@ -132,53 +196,51 @@
-
-
- Defined in src/guards/admin-maybe.guard.ts:19
-
-
+
+
+ Defined in src/guards/admin-maybe.guard.ts:19
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- context
-
- ExecutionContext
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ context
+
+ ExecutionContext
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -201,67 +263,65 @@
-
-
- Defined in src/guards/admin-maybe.guard.ts:23
-
-
+
+
+ Defined in src/guards/admin-maybe.guard.ts:23
+
+
-
- Parameters :
-
-
-
-
- Name
- Optional
-
-
-
-
- error
-
-
- No
-
-
-
-
-
- authInfo
-
-
- No
-
-
-
-
-
- errInfo
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Optional
+
+
+
+
+ error
+
+
+ No
+
+
+
+
+
+ authInfo
+
+
+ No
+
+
+
+
+
+ errInfo
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/injectables/AdminOnlyGuard.html b/injectables/AdminOnlyGuard.html
index 2bfb92ba..b33e44ca 100644
--- a/injectables/AdminOnlyGuard.html
+++ b/injectables/AdminOnlyGuard.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -72,9 +130,15 @@ File
Description
-
+ Example :
+
+
Extends
+
+
+ AuthGuard('jwt')
+
@@ -132,53 +196,51 @@
-
-
- Defined in src/guards/admin-only.guard.ts:19
-
-
+
+
+ Defined in src/guards/admin-only.guard.ts:19
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- context
-
- ExecutionContext
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ context
+
+ ExecutionContext
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
@@ -201,67 +263,65 @@
-
-
- Defined in src/guards/admin-only.guard.ts:23
-
-
+
+
+ Defined in src/guards/admin-only.guard.ts:23
+
+
-
- Parameters :
-
-
-
-
- Name
- Optional
-
-
-
-
- error
-
-
- No
-
-
-
-
-
- authInfo
-
-
- No
-
-
-
-
-
- errInfo
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : any
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Optional
+
+
+
+
+ error
+
+
+ No
+
+
+
+
+
+ authInfo
+
+
+ No
+
+
+
+
+
+ errInfo
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : any
+
+
+
+
+
diff --git a/injectables/AkismetService.html b/injectables/AkismetService.html
index 8c66d9bd..ab90c7eb 100644
--- a/injectables/AkismetService.html
+++ b/injectables/AkismetService.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -150,7 +208,7 @@ Constructor
-
+
@@ -169,7 +227,7 @@
- Public
+ Public
checkSpam
@@ -177,59 +235,57 @@
-
+
checkSpam(payload: AkismetPayload)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- AkismetPayload
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<any>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ AkismetPayload
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<any>
+
+
+
+
+
@@ -240,7 +296,7 @@
- Private
+ Private
initClient
@@ -248,27 +304,27 @@
-
+
initClient()
-
-
-
-
-
+
+
+
+
+
-
@@ -279,7 +335,7 @@
- Private
+ Private
initVerify
@@ -287,27 +343,27 @@
-
+
initVerify()
-
-
-
-
-
+
+
+
+
+
-
@@ -318,7 +374,7 @@
- Private
+ Private
makeInterceptor
@@ -326,59 +382,57 @@
-
+
makeInterceptor(handleType: AkismetAction)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- handleType
-
- AkismetAction
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : (content: AkismetPayload) => Promise<any>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ handleType
+
+ AkismetAction
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : (content: AkismetPayload) => Promise<any>
+
+
+
+
+
@@ -389,7 +443,7 @@
- Public
+ Public
submitHam
@@ -397,59 +451,57 @@
-
+
submitHam(payload: AkismetPayload)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- AkismetPayload
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<any>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ AkismetPayload
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<any>
+
+
+
+
+
@@ -460,7 +512,7 @@
- Public
+ Public
submitSpam
@@ -468,59 +520,57 @@
-
+
submitSpam(payload: AkismetPayload)
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- payload
-
- AkismetPayload
-
-
-
- No
-
-
-
-
-
-
-
-
-
-
- Returns : Promise<any>
-
-
-
-
-
+
+ Parameters :
+
+
+
+
+ Name
+ Type
+ Optional
+
+
+
+
+ payload
+
+ AkismetPayload
+
+
+
+ No
+
+
+
+
+
+
+
+
+ Returns : Promise<any>
+
+
+
+
+
@@ -551,7 +601,7 @@
-
+
@@ -577,7 +627,7 @@
-
+
@@ -594,10 +644,11 @@
import { Injectable } from '@nestjs/common'
import { UNDEFINED } from '@app/constants/value.constant'
import { getMessageFromNormalError } from '@app/transformers/error.transformer'
+import { createLogger } from '@app/utils/logger'
+import { isDevEnv } from '@app/app.environment'
import * as APP_CONFIG from '@app/app.config'
-import logger from '@app/utils/logger'
-const log = logger.scope('AkismetService')
+const logger = createLogger({ scope: 'AkismetService', time: isDevEnv })
// keyof typeof AkismetClient
export enum AkismetAction {
@@ -643,11 +694,11 @@
.then((valid) => (valid ? Promise.resolve(valid) : Promise.reject('Invalid Akismet key')))
.then(() => {
this.clientIsValid = true
- log.info('client init succeed.')
+ logger.success('client init succeed.')
})
.catch((error) => {
this.clientIsValid = false
- log.error('client init failed!', getMessageFromNormalError(error))
+ logger.failure('client init failed!', '|', getMessageFromNormalError(error))
})
}
@@ -657,11 +708,11 @@
// continue operation only when initialization successful
if (!this.clientIsValid) {
const message = `${handleType} failed! reason: init failed`
- log.warn(message)
+ logger.warn(message)
return resolve(message)
}
- log.info(`${handleType}...`, new Date())
+ logger.log(`${handleType}...`, new Date())
this.client[handleType]({
...content,
permalink: content.permalink || UNDEFINED,
@@ -672,16 +723,16 @@
})
.then((result) => {
if (handleType === AkismetAction.CheckSpam && result) {
- log.warn(`${handleType} found SPAM!`, new Date(), content)
+ logger.info(`${handleType} found SPAM!`, new Date(), content)
reject('SPAM!')
} else {
- log.info(`${handleType} succeed.`)
+ logger.info(`${handleType} succeed.`)
resolve(result)
}
})
.catch((error) => {
const message = `${handleType} failed!`
- log.error(message, error)
+ logger.warn(message, error)
reject(message)
})
})
diff --git a/injectables/AnnouncementService.html b/injectables/AnnouncementService.html
index ae3b56a8..651b8823 100644
--- a/injectables/AnnouncementService.html
+++ b/injectables/AnnouncementService.html
@@ -12,6 +12,64 @@
+
NodePress documentation
@@ -176,7 +234,7 @@
- Public
+ Public
batchDelete
@@ -184,59 +242,57 @@
-
+
batchDelete(announcementIDs: MongooseID[])
-
-
-
-
-
+
+
+
+
+
-
- Parameters :
-
-
-
-
- Name
- Type
- Optional
-
-
-
-
- announcementIDs
-
-