Class ChatCollection

Whatsapp

69951

Whatsapp

669951 >= 2.2222.8

Hierarchy (View Summary)

Constructors

constructor

Properties

findFirst modelClass notSpam? onResume promises? cachePolicy model

Accessors

length

Methods

active add assertGet at bind delete disableSortListener emit enableSortListener every filter find findQuery forEach forwardMessagesToChats gadd gaddUp get getKeysForResyncMsgs getModelsArray handle head includes indexOf initializeFromCache isListening isModel isStateStale last lastIndexOf listenTo listenToAndRun listenToOnce map off on once reduce remove removeAllListeners removeListener reorder reorderMutate replaceId reset resyncMessages saveToCache serialize set setIndexes slice some sort stopListening sync toArray toJSON trigger unbind unstarAllMessages update where comparator

Constructors

constructor

Properties

findFirst

findFirst: {
    <S extends ChatModel>(
        predicate: (
            value: ChatModel,
            index: number,
            obj: ChatModel[],
        ) => value is S,
        thisArg?: any,
    ): undefined | S;
    (
        predicate: (
            value: ChatModel,
            index: number,
            obj: ChatModel[],
        ) => unknown,
        thisArg?: any,
    ): undefined | ChatModel;
}

Type declaration

    • <S extends ChatModel>(
          predicate: (
              value: ChatModel,
              index: number,
              obj: ChatModel[],
          ) => value is S,
          thisArg?: any,
      ): undefined | S

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Type Parameters

      Parameters

      • predicate: (value: ChatModel, index: number, obj: ChatModel[]) => value is S

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • OptionalthisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns undefined | S

    • (
          predicate: (
              value: ChatModel,
              index: number,
              obj: ChatModel[],
          ) => unknown,
          thisArg?: any,
      ): undefined | ChatModel

    • Parameters

      • predicate: (value: ChatModel, index: number, obj: ChatModel[]) => unknown
      • OptionalthisArg: any

      Returns undefined | ChatModel

modelClass

modelClass: ChatModel

OptionalnotSpam

notSpam?: any

onResume

onResume: (...args: any) => any

Optionalpromises

promises?: any

StaticcachePolicy

cachePolicy: { id: string; policy: string; trigger: string }

Staticmodel

model: ChatModel

Accessors

length

Methods

active

add

assertGet

at

bind

delete

disableSortListener

emit

enableSortListener

every

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

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

    Type Parameters

    Parameters

    • predicate: (value: ChatModel, index: number, array: ChatModel[]) => 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: ChatModel,
            index: number,
            array: ChatModel[],
        ) => unknown,
        thisArg?: any,
    ): boolean

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

    Parameters

    • predicate: (value: ChatModel, index: number, array: ChatModel[]) => 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 ChatModel>(
        predicate: (
            value: ChatModel,
            index: number,
            array: ChatModel[],
        ) => value is S,
        thisArg?: any,
    ): S[]

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

    Type Parameters

    Parameters

    • predicate: (value: ChatModel, index: number, array: ChatModel[]) => 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: ChatModel,
            index: number,
            array: ChatModel[],
        ) => unknown,
        thisArg?: any,
    ): ChatModel[]

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

    Parameters

    • predicate: (value: ChatModel, index: number, array: ChatModel[]) => 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 ChatModel[]

find

findQuery

forEach

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

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: ChatModel, index: number, array: ChatModel[]) => 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

forwardMessagesToChats

gadd

gaddUp

get

getKeysForResyncMsgs

getModelsArray

handle

head

includes

indexOf

  • indexOf(searchElement: ChatModel, 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: ChatModel

      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

isListening

isModel

isStateStale

last

lastIndexOf

  • lastIndexOf(searchElement: ChatModel, 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: ChatModel

      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: ChatModel, index: number, array: ChatModel[]) => 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: ChatModel, index: number, array: ChatModel[]) => 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: ChatModel,
            currentValue: ChatModel,
            currentIndex: number,
            array: ChatModel[],
        ) => ChatModel,
    ): ChatModel

  • 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: ChatModel,
          currentValue: ChatModel,
          currentIndex: number,
          array: ChatModel[],
      ) => ChatModel

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

    Returns ChatModel

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

  • Parameters

    Returns ChatModel

  • reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: ChatModel,
            currentIndex: number,
            array: ChatModel[],
        ) => 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: ChatModel,
          currentIndex: number,
          array: ChatModel[],
      ) => 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

removeAllListeners

removeListener

reorder

reorderMutate

replaceId

reset

resyncMessages

saveToCache

serialize

set

setIndexes

slice

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

  • 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 ChatModel[]

some

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

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

    Parameters

    • predicate: (value: ChatModel, index: number, array: ChatModel[]) => 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

stopListening

sync

toArray

toJSON

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

unstarAllMessages

update

where

Staticcomparator

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods