Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModelWithUsersRoles

Hierarchy

  • Model
    • ModelWithUsersRoles

Index

Properties

Accessors

Methods

Properties

_createdAt

_createdAt: Date

_createdBy

_createdBy: ObjectId

_id

_id: ObjectId

_updatedAt

_updatedAt: Date

_updatedBy

_updatedBy: ObjectId

filesToRemove

filesToRemove: string[] = ...

Optional model

model: typeof Model

request

request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

response

response: Response<any, Record<string, any>>

Optional users

users: UserRoles[]

Accessors

deco

Methods

canGetOne

  • canGetOne(options?: any): Promise<boolean>

canInsert

  • canInsert(options?: any): Promise<boolean>

canRemove

  • canRemove(options?: any): Promise<boolean>

canUpdate

  • canUpdate(options?: any): Promise<boolean>

decoFromRequest

  • decoFromRequest(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Deco

get

  • get(propertyName: string): any

getAgain

  • getAgain<T>(): Promise<null | T>

insert

  • insert(): Promise<any>

insertMany

  • insertMany(quantity?: number): Promise<any[]>

insertWithDocument

  • insertWithDocument<T>(): Promise<T>

output

  • output(includeProps?: string[], ignoreIO?: boolean, includeExtraKeys?: string[]): Promise<any>

  • Parameters

    • Optional includeProps: string[]
    • ignoreIO: boolean = false
    • includeExtraKeys: string[] = ...

    Returns Promise<any>

remove

  • remove(): Promise<boolean>

set

  • set(propertyName: string, value: any): void

smartUpdate

  • smartUpdate<T>(): Promise<T>

  • Compare the element that was retrieve from the database and only update keys that have been changed since

    Type parameters

    Returns Promise<T>

toDocument

  • toDocument(operation: "insert" | "update" | "upsert", properties?: string[]): Promise<UpdateQuery>

update

  • update<T>(properties: string[]): Promise<T>

updateInstanceFromRequest

  • updateInstanceFromRequest<T>(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>): Promise<T>

validate

  • validate(properties?: string[]): Promise<boolean>

Generated using TypeDoc