Class MsgLoad

constructor

• new MsgLoad(e?: any, t?: { parent: any }): MsgLoad

  Parameters

  • Optionale: any
  • Optionalt: { parent: any }

  Returns MsgLoad

findFirst

OptionalloadAroundPromise

OptionalloadEarlierPromise

OptionalloadRecentPromise

modelClass

msgLoadState

onResume

StaticcachePolicy

Staticcomparator

Staticmodel

length

• get length(): number

  Returns number

add

• add(
      value: MsgModel | MsgModel[] | WritableProperties<MsgModel | MsgModel[]>,
      options?: Option,
  ): MsgModel | MsgModel[]

  Parameters

  • value: MsgModel | MsgModel[] | WritableProperties<MsgModel | MsgModel[]>
  • Optionaloptions: Option

  Returns MsgModel | MsgModel[]

assertGet

• assertGet(e: Stringable): MsgModel

  Parameters

  • e: Stringable

  Returns MsgModel

at

• at(position: number): MsgModel

  Parameters

  • position: number

  Returns MsgModel

bind

• bind(eventName: Event, listener: Listener, context?: any): this

  Alias of on

  Parameters

  • eventName: Event
  • listener: Listener
  • Optionalcontext: any

  Returns this

  Alias

  on

delete

• delete(): void

  Returns void

emit

• emit(eventName: Event, ...args: any[]): this

  Alias of trigger

  Parameters

  • eventName: Event
  • ...args: any[]

  Returns this

  Alias

  trigger

every

• every<S extends MsgModel>(
      predicate: (
          value: MsgModel,
          index: number,
          array: MsgModel[],
      ) => value is S,
      thisArg?: any,
  ): this is S[]

  Determines whether all the members of an array satisfy the specified test.

  Type Parameters

  • S extends MsgModel

  Parameters

  • predicate: (value: MsgModel, index: number, array: MsgModel[]) => value is S

    A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns this is S[]
• every(
      predicate: (
          value: MsgModel,
          index: number,
          array: MsgModel[],
      ) => unknown,
      thisArg?: any,
  ): boolean

  Determines whether all the members of an array satisfy the specified test.

  Parameters

  • predicate: (value: MsgModel, index: number, array: MsgModel[]) => unknown

    A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns boolean

filter

• filter<S extends MsgModel>(
      predicate: (
          value: MsgModel,
          index: number,
          array: MsgModel[],
      ) => value is S,
      thisArg?: any,
  ): S[]

  Returns the elements of an array that meet the condition specified in a callback function.

  Type Parameters

  • S extends MsgModel

  Parameters

  • predicate: (value: MsgModel, index: number, array: MsgModel[]) => value is S

    A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns S[]
• filter(
      predicate: (
          value: MsgModel,
          index: number,
          array: MsgModel[],
      ) => unknown,
      thisArg?: any,
  ): MsgModel[]

  Returns the elements of an array that meet the condition specified in a callback function.

  Parameters

  • predicate: (value: MsgModel, index: number, array: MsgModel[]) => unknown

    A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns MsgModel[]

find

• find(
      id: Stringable,
      options?: { logOnSend?: boolean; set?: boolean },
  ): Promise<MsgModel>

  Parameters

  • id: Stringable
  • Optionaloptions: { logOnSend?: boolean; set?: boolean }

  Returns Promise<MsgModel>

findQuery

• findQuery(
      id: Stringable,
      options?: { logOnSend?: boolean; set?: boolean },
  ): Promise<MsgModel>

  Parameters

  • id: Stringable
  • Optionaloptions: { logOnSend?: boolean; set?: boolean }

  Returns Promise<MsgModel>

forEach

• forEach(
      callbackfn: (value: MsgModel, index: number, array: MsgModel[]) => void,
      thisArg?: any,
  ): void

  Performs the specified action for each element in an array.

  Parameters

  • callbackfn: (value: MsgModel, index: number, array: MsgModel[]) => void

    A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

  Returns void

gadd

• gadd(id: MsgModel | Stringable, options?: any): MsgModel

  Parameters

  • id: MsgModel | Stringable
  • Optionaloptions: any

  Returns MsgModel

gaddUp

• gaddUp(id: MsgModel | Stringable): MsgModel

  Parameters

  • id: MsgModel | Stringable

  Returns MsgModel

get

• get(e: Stringable): MsgModel

  Parameters

  • e: Stringable

  Returns MsgModel

getModelsArray

• getModelsArray(): MsgModel[]

  Returns MsgModel[]

handle

• handle(values: MsgModel | MsgModel[]): void

  Parameters

  • values: MsgModel | MsgModel[]

  Returns void

head

• head(): MsgModel

  Returns MsgModel

includes

• includes(model: MsgModel, position?: number): boolean

  Parameters

  • model: MsgModel
  • Optionalposition: number

  Returns boolean

indexOf

• indexOf(searchElement: MsgModel, fromIndex?: number): number

  Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

  Parameters

  • searchElement: MsgModel

    The value to locate in the array.
  • OptionalfromIndex: number

    The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

  Returns number

initializeFromCache

• initializeFromCache(value: MsgModel | MsgModel[]): void

  Parameters

  • value: MsgModel | MsgModel[]

  Returns void

isListening

• isListening(eventName: Event): boolean

  Parameters

  • eventName: Event

  Returns boolean

isModel

• isModel(model: any): model is MsgModel

  Parameters

  • model: any

  Returns model is MsgModel

isStateStale

• isStateStale(id: Stringable): boolean

  Parameters

  • id: Stringable

  Returns boolean

last

• last(): MsgModel

  Returns MsgModel

lastIndexOf

• lastIndexOf(searchElement: MsgModel, fromIndex?: number): number

  Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

  Parameters

  • searchElement: MsgModel

    The value to locate in the array.
  • OptionalfromIndex: number

    The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

  Returns number

listenTo

• listenTo(context: any, eventName: Event, listener?: Listener): this

  Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.

  Returns this

listenToAndRun

• listenToAndRun(context: any, eventName: Event, listener?: Listener): this

  Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.

  Returns this

listenToOnce

• listenToOnce(context: any, eventName: Event, listener?: Listener): this

  Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.

  Returns this

map

• map<U>(
      callbackfn: (value: MsgModel, index: number, array: MsgModel[]) => U,
      thisArg?: any,
  ): U[]

  Calls a defined callback function on each element of an array, and returns an array that contains the results.

  Type Parameters

  • U

  Parameters

  • callbackfn: (value: MsgModel, index: number, array: MsgModel[]) => U

    A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

  Returns U[]

off

• off(eventName?: Event, listener?: Listener, context?: any): this

  Removes the specified listener from the listener array for the event named eventName.

  Parameters

  • OptionaleventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.
  • Optionalcontext: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

on

• on(eventName: Event, listener: Listener, context?: any): this

  Adds the listener function to the end of the listeners array for the event named eventName.

  Parameters

  • eventName: Event

    The name of the event.
  • listener: Listener

    The callback function.
  • Optionalcontext: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

once

• once(eventName: Event, listener: Listener, context?: any): this

  Adds a one-time listener function for the event named eventName.

  Parameters

  • eventName: Event

    The name of the event.
  • listener: Listener

    The callback function.
  • Optionalcontext: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

reduce

• reduce(
      callbackfn: (
          previousValue: MsgModel,
          currentValue: MsgModel,
          currentIndex: number,
          array: MsgModel[],
      ) => MsgModel,
  ): MsgModel

  Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Parameters

  • callbackfn: (
        previousValue: MsgModel,
        currentValue: MsgModel,
        currentIndex: number,
        array: MsgModel[],
    ) => MsgModel

    A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

  Returns MsgModel
• reduce(
      callbackfn: (
          previousValue: MsgModel,
          currentValue: MsgModel,
          currentIndex: number,
          array: MsgModel[],
      ) => MsgModel,
      initialValue: MsgModel,
  ): MsgModel

  Parameters

  • callbackfn: (
        previousValue: MsgModel,
        currentValue: MsgModel,
        currentIndex: number,
        array: MsgModel[],
    ) => MsgModel
  • initialValue: MsgModel

  Returns MsgModel

• reduce<U>(
      callbackfn: (
          previousValue: U,
          currentValue: MsgModel,
          currentIndex: number,
          array: MsgModel[],
      ) => U,
      initialValue: U,
  ): U

  Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

  Type Parameters

  • U

  Parameters

  • callbackfn: (
        previousValue: U,
        currentValue: MsgModel,
        currentIndex: number,
        array: MsgModel[],
    ) => U

    A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  • initialValue: U

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

  Returns U

remove

• remove(
      value: MsgModel | MsgModel[],
      options?: { index?: boolean; silent?: boolean },
  ): MsgModel[]

  Parameters

  • value: MsgModel | MsgModel[]
  • Optionaloptions: { index?: boolean; silent?: boolean }

  Returns MsgModel[]

removeAllListeners

• removeAllListeners(): this

  Removes all listeners.

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

removeListener

• removeListener(eventName?: Event, listener?: Listener, context?: any): this

  Alias of off

  Parameters

  • OptionaleventName: Event
  • Optionallistener: Listener
  • Optionalcontext: any

  Returns this

  Alias

  off

reorder

• reorder(e: number, t: number): MsgModel[]

  Parameters

  • e: number
  • t: number

  Returns MsgModel[]

reorderMutate

• reorderMutate(e: any, t: any): void

  Parameters

  • e: any
  • t: any

  Returns void

replaceId

• replaceId(e: any, t: any): void

  Parameters

  • e: any
  • t: any

  Returns void

reset

• reset(): void

  Returns void

saveToCache

• saveToCache(): void

  Returns void

serialize

• serialize(): any[]

  Returns any[]

set

• set(value: MsgModel | MsgModel[], options?: Option): MsgModel | MsgModel[]

  Parameters

  • value: MsgModel | MsgModel[]
  • Optionaloptions: Option

  Returns MsgModel | MsgModel[]

slice

• slice(start?: number, end?: number): MsgModel[]

  Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

  Parameters

  • Optionalstart: number

    The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.
  • Optionalend: number

    The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

  Returns MsgModel[]

some

• some(
      predicate: (
          value: MsgModel,
          index: number,
          array: MsgModel[],
      ) => unknown,
      thisArg?: any,
  ): boolean

  Determines whether the specified callback function returns true for any element of an array.

  Parameters

  • predicate: (value: MsgModel, index: number, array: MsgModel[]) => unknown

    A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
  • OptionalthisArg: any

    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

  Returns boolean

sort

• sort(options?: { silent?: boolean }): this

  Parameters

  • Optionaloptions: { silent?: boolean }

  Returns this

stopListening

• stopListening(context?: any, eventName?: Event, listener?: Listener): this

  Parameters

  • Optionalcontext: any
  • OptionaleventName: Event
  • Optionallistener: Listener

  Returns this

toArray

• toArray(): MsgModel[]

  Returns MsgModel[]

toJSON

• toJSON(): any[]

  Returns any[]

trigger

• trigger(eventName: Event, ...args: any[]): this

  Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

  Parameters

  • eventName: Event
  • ...args: any[]

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

unbind

• unbind(eventName?: Event, listener?: Listener, context?: any): this

  Alias of off

  Parameters

  • OptionaleventName: Event
  • Optionallistener: Listener
  • Optionalcontext: any

  Returns this

  Alias

  off

update

• update(
      id: Stringable,
      options?: { logOnSend?: boolean; set?: boolean },
  ): Promise<MsgModel>

  Parameters

  • id: Stringable
  • Optionaloptions: { logOnSend?: boolean; set?: boolean }

  Returns Promise<MsgModel>

where

• where(ids: Stringable[]): MsgModel[]

  Parameters

  • ids: Stringable[]

  Returns MsgModel[]