AcademicSubjectModel | kp-session-bot

Hierarchy

PaginateModel<AcademicSubjectDoc>
CrudPluginStatics<AcademicSubjectDoc>
PickRandomPluginStatics<AcademicSubjectData, AcademicSubjectDoc>
AcademicSubjectStatics
- AcademicSubjectModel

Index

Properties

Model

Methods

Properties

Model

Model: Model<any>

Methods

paginate

paginate(query?: Object, options?: PaginateOptions, callback?: undefined | function): Promise<PaginateResult<AcademicSubjectDoc>>

Inherited from PaginateModel.paginate
- Defined in node_modules/@types/mongoose-paginate/index.d.ts:31
Parameters
- Optional query: Object
- Optional options: PaginateOptions
- Optional callback: undefined | function
Returns Promise<PaginateResult<AcademicSubjectDoc>>

tryDeleteById

tryDeleteById(this: Model<AcademicSubjectDoc>, id: ObjectId): Promise<AcademicSubjectDoc>

Inherited from CrudPluginStatics.tryDeleteById
- Defined in modules/mongoose-plugins/apollo-crud.ts:7
Parameters
- this: Model<AcademicSubjectDoc>
- id: ObjectId
Returns Promise<AcademicSubjectDoc>

tryFindById

tryFindById(this: Model<AcademicSubjectDoc>, id: ObjectId): Promise<AcademicSubjectDoc>

Inherited from CrudPluginStatics.tryFindById
- Defined in modules/mongoose-plugins/apollo-crud.ts:13
Parameters
- this: Model<AcademicSubjectDoc>
- id: ObjectId
Returns Promise<AcademicSubjectDoc>

tryFindByName

tryFindByName(this: AcademicSubjectModel, name: string): Promise<AcademicSubjectDoc>

Inherited from AcademicSubjectStatics.tryFindByName
- Defined in models/declarations/academic-subject.ts:50
Tries to retrieve AcademicSubjectDoc from db by name field.

throws

ApolloError if no such AcademicSubjectDoc was found.

Parameters
- this: AcademicSubjectModel
- name: string
  
  Name of AcademicSubjectDoc to search for.
Returns Promise<AcademicSubjectDoc>

tryFindOne

tryFindOne(this: Model<AcademicSubjectDoc>, queryObj: BasicObject): Promise<AcademicSubjectDoc>

Inherited from CrudPluginStatics.tryFindOne
- Defined in modules/mongoose-plugins/apollo-crud.ts:14
Parameters
- this: Model<AcademicSubjectDoc>
- queryObj: BasicObject
Returns Promise<AcademicSubjectDoc>

tryPickRandomDocuments

tryPickRandomDocuments<ProjectedData>(this: Model<AcademicSubjectDoc>, docsAmount: number, projection?: Maybe<ProjectionOperand<AcademicSubjectData>>): Promise<ProjectedData[]>

Inherited from PickRandomPluginStatics.tryPickRandomDocuments
- Defined in modules/mongoose-plugins/pick-random.ts:28
Tries to pick random docsAmount of unique documents from the database collection.

throws

NotEnoughDocumentsError if docsAmount is greater than the total amount of documents stored in the database collection.

Type parameters
- ProjectedData
Parameters
- this: Model<AcademicSubjectDoc>
- docsAmount: number
  
  Exact amount of documents to pick randomly.
- Optional projection: Maybe<ProjectionOperand<AcademicSubjectData>>
  
  Projection stage operator to apply to retrieved documents.
Returns Promise<ProjectedData[]>

tryUpdateById

tryUpdateById(this: Model<AcademicSubjectDoc>, id: ObjectId, update: BasicObject): Promise<AcademicSubjectDoc>

Inherited from CrudPluginStatics.tryUpdateById
- Defined in modules/mongoose-plugins/apollo-crud.ts:8
Parameters
- this: Model<AcademicSubjectDoc>
- id: ObjectId
- update: BasicObject
Returns Promise<AcademicSubjectDoc>

Hierarchy

Index

Properties

Methods

Properties

Model

Methods

paginate

Parameters

Optional query: Object

Optional options: PaginateOptions

Optional callback: undefined | function

Returns Promise<PaginateResult<AcademicSubjectDoc>>

tryDeleteById

Parameters

this: Model<AcademicSubjectDoc>

id: ObjectId

Returns Promise<AcademicSubjectDoc>

tryFindById

Parameters

this: Model<AcademicSubjectDoc>

id: ObjectId

Returns Promise<AcademicSubjectDoc>

tryFindByName

Parameters

this: AcademicSubjectModel

name: string

Returns Promise<AcademicSubjectDoc>

tryFindOne

Parameters

this: Model<AcademicSubjectDoc>

queryObj: BasicObject

Returns Promise<AcademicSubjectDoc>

tryPickRandomDocuments

Type parameters

ProjectedData

Parameters

this: Model<AcademicSubjectDoc>

docsAmount: number

Optional projection: Maybe<ProjectionOperand<AcademicSubjectData>>

Returns Promise<ProjectedData[]>

tryUpdateById

Parameters

this: Model<AcademicSubjectDoc>

id: ObjectId

update: BasicObject

Returns Promise<AcademicSubjectDoc>