Class RWSModel<ChildClass>

constructor

• new RWSModel<ChildClass>(data?): RWSModel<ChildClass>

• Type Parameters

  • ChildClass

  Parameters

  • Optional data: any

  Returns RWSModel<ChildClass>

id

Static _BANNED_KEYS

Static _collection

_asyncFill

• _asyncFill(data): Promise<ChildClass>

• Parameters

  • data: any

  Returns Promise<ChildClass>

checkForInclusion

• checkForInclusion(): boolean

• Returns boolean

checkForInclusionWithThrow

• checkForInclusionWithThrow(): void

• Returns void

delete

• delete<ChildClass>(): Promise<void>

• Type Parameters

  • ChildClass extends RWSModel<ChildClass>

  Returns Promise<void>

getCollection

• getCollection(): string

• Returns string

hasTimeSeries

• hasTimeSeries(): boolean

• Returns boolean

isDbVariable

• isDbVariable(variable): boolean

• Parameters

  • variable: string

  Returns boolean

loadModels

• loadModels(): RWSModel<any>[]

• Returns RWSModel<any>[]

postCreate

• postCreate(): void

• Returns void

postUpdate

• postUpdate(): void

• Returns void

preCreate

• preCreate(): void

• Returns void

preUpdate

• preUpdate(): void

• Returns void

sanitizeDBData

• sanitizeDBData(data): any

• Parameters

  • data: any

  Returns any

save

• save(): Promise<RWSModel<ChildClass>>

• Returns Promise<RWSModel<ChildClass>>

toMongo

• toMongo(): any

• Returns any

Static checkDbVariable

• checkDbVariable(constructor, variable): boolean

• Parameters

  • constructor: any

  • variable: string

  Returns boolean

Static checkForInclusion

• checkForInclusion(this, checkModelType): boolean

• Parameters

  • this: OpModelType<any>

  • checkModelType: string

  Returns boolean

Static checkForInclusionWithThrow

• checkForInclusionWithThrow(this, checkModelType): void

• Parameters

  • this: OpModelType<any>

  • checkModelType: string

  Returns void

Static checkTimeSeries

• checkTimeSeries(constructor): boolean

• Parameters

  • constructor: any

  Returns boolean

Static create

• create<T>(this, data): Promise<T>

• Type Parameters

  • T extends RWSModel<T>

  Parameters

  • this: (new () => T)

    • • new (): T

      • Returns T

  • data: any

  Returns Promise<T>

Static delete

• delete<ChildClass>(this, conditions): Promise<void>

• Type Parameters

  • ChildClass extends RWSModel<ChildClass>

  Parameters

  • this: OpModelType<ChildClass>

  • conditions: any

  Returns Promise<void>

Static find

• find<ChildClass>(this, id, fields?, ordering?): Promise<ChildClass>

• Type Parameters

  • ChildClass extends RWSModel<ChildClass>

  Parameters

  • this: OpModelType<ChildClass>

  • id: string

  • fields: string[] = null

  • ordering: {
        [fieldName: string]: string;
    } = null

    • [fieldName: string]: string

  Returns Promise<ChildClass>

Static findBy

• findBy<ChildClass>(this, conditions, fields?, ordering?): Promise<ChildClass[]>

• Type Parameters

  • ChildClass extends RWSModel<ChildClass>

  Parameters

  • this: OpModelType<ChildClass>

  • conditions: any

  • fields: string[] = null

  • ordering: {
        [fieldName: string]: string;
    } = null

    • [fieldName: string]: string

  Returns Promise<ChildClass[]>

Static findOneBy

• findOneBy<ChildClass>(this, conditions, fields?, ordering?): Promise<ChildClass>

• Type Parameters

  • ChildClass extends RWSModel<ChildClass>

  Parameters

  • this: OpModelType<ChildClass>

  • conditions: {
        [fieldName: string]: any;
    }

    • [fieldName: string]: any

  • fields: string[] = null

  • ordering: {
        [fieldName: string]: string;
    } = null

    • [fieldName: string]: string

  Returns Promise<ChildClass>

Static getCollection

• getCollection(): string

• Returns string

Static getModelAnnotations

• getModelAnnotations<T>(constructor): Record<string, {
      annotationType: string;
      metadata: any;
  }>

• Type Parameters

  • T extends object

  Parameters

  • constructor: (new () => T)

    • • new (): T

      • Returns T

  Returns Record<string, {
      annotationType: string;
      metadata: any;
  }>

Static isSubclass

• isSubclass<T, C>(constructor, baseClass): boolean

• Type Parameters

  • T extends RWSModel<T>

  • C extends (new () => T)

  Parameters

  • constructor: C

  • baseClass: (new () => T)

    • • new (): T

      • Returns T

  Returns boolean

Static loadModels

• loadModels(): RWSModel<any>[]

• Returns RWSModel<any>[]

Static watchCollection

• watchCollection<ChildClass>(this, preRun): Promise<any>

• Type Parameters

  • ChildClass extends RWSModel<ChildClass>

  Parameters

  • this: OpModelType<ChildClass>

  • preRun: (() => void)

    • • (): void

      • Returns void

  Returns Promise<any>