Class NoteCollection

Whatsapp

WAWebNoteCollection

Hierarchy (view full)

Constructors

constructor

Properties

findFirst modelClass comparator model

Accessors

length

Methods

add assertGet at bind emit every filter forEach get getModelsArray hasCachedQueryForChatJid head includes indexOf isListening isModel last lastIndexOf listenTo listenToAndRun listenToOnce map maybeGetNoteByChatJid off on once purgeNotesByChatJid reduce remove removeAllListeners removeListener reorder reorderMutate replaceId reset serialize set slice some sort stopListening toArray toJSON trigger unbind updateCollectionFromDB where

Constructors

constructor

  • new NoteCollection(e?, t?): NoteCollection

  • Parameters

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

    Returns NoteCollection

Properties

findFirst

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

Type declaration

    • <S>(predicate, thisArg?): S

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

      Type Parameters

      Parameters

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

          • (value, index, obj): value is S

          • Parameters

            Returns value is S

      • 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 S

    • (predicate, thisArg?): NoteModel

    • Parameters

      • predicate: ((value: NoteModel, index: number, obj: NoteModel[]) => unknown)
          • (value, index, obj): unknown

          • Parameters

            Returns unknown

      • OptionalthisArg: any

      Returns NoteModel

modelClass

modelClass: NoteModel

Staticcomparator

comparator: ((a: any, b: any) => number)

Staticmodel

model: NoteModel

Accessors

length

  • get length(): number

  • Returns number

Methods

add

assertGet

at

  • at(position): NoteModel

  • Parameters

    • position: number

    Returns NoteModel

bind

  • bind(eventName, listener, context?): this

  • Alias of on

    Parameters

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

    Returns this

    Alias

    on

emit

  • emit(eventName, ...args): this

  • Alias of trigger

    Parameters

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

    Returns this

    Alias

    trigger

every

  • every<S>(predicate, thisArg?): this is S[]

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

    Type Parameters

    Parameters

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

        • (value, index, array): value is S

        • Parameters

          Returns value is S

    • 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, thisArg?): boolean

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

    Parameters

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

        • (value, index, array): unknown

        • Parameters

          Returns unknown

    • 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>(predicate, thisArg?): S[]

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

    Type Parameters

    Parameters

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

        • (value, index, array): value is S

        • Parameters

          Returns value is S

    • 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, thisArg?): NoteModel[]

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

    Parameters

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

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

        • (value, index, array): unknown

        • Parameters

          Returns unknown

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

forEach

  • forEach(callbackfn, thisArg?): void

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

    Parameters

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

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

        • (value, index, array): void

        • Parameters

          Returns void

    • 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

get

  • get(e): NoteModel

  • Parameters

    • e: Stringable

    Returns NoteModel

getModelsArray

hasCachedQueryForChatJid

  • hasCachedQueryForChatJid(e?): any

  • Parameters

    • Optionale: any

    Returns any

head

includes

  • includes(model, position?): boolean

  • Parameters

    Returns boolean

indexOf

  • indexOf(searchElement, fromIndex?): number

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

    Parameters

    • searchElement: NoteModel

      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

isListening

  • isListening(eventName): boolean

  • Parameters

    • eventName: Event

    Returns boolean

isModel

  • isModel(model): model is NoteModel

  • Parameters

    • model: any

    Returns model is NoteModel

last

lastIndexOf

  • lastIndexOf(searchElement, fromIndex?): number

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

    Parameters

    • searchElement: NoteModel

      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, eventName, 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, eventName, 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, eventName, 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, thisArg?): 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: NoteModel, index: number, array: NoteModel[]) => 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[]

maybeGetNoteByChatJid

  • maybeGetNoteByChatJid(a?): any

  • Parameters

    • Optionala: any

    Returns any

off

  • off(eventName?, listener?, context?): 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, listener, context?): 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, listener, context?): 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.

purgeNotesByChatJid

  • purgeNotesByChatJid(a?): any

  • Parameters

    • Optionala: any

    Returns any

reduce

  • reduce(callbackfn): NoteModel

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

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

    Returns NoteModel

  • reduce(callbackfn, initialValue): NoteModel

  • Parameters

    Returns NoteModel

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

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

        • (previousValue, currentValue, currentIndex, array): U

        • Parameters

          Returns U

    • 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, options?): NoteModel[]

  • Parameters

    • value: NoteModel | NoteModel[]
    • Optionaloptions: {
          index?: boolean;
          silent?: boolean;
      }
      • Optionalindex?: boolean
      • Optionalsilent?: boolean

    Returns NoteModel[]

removeAllListeners

  • removeAllListeners(): this

  • Removes all listeners.

    Returns this

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

removeListener

  • removeListener(eventName?, listener?, context?): this

  • Alias of off

    Parameters

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

    Returns this

    Alias

    off

reorder

  • reorder(e, t): NoteModel[]

  • Parameters

    • e: number
    • t: number

    Returns NoteModel[]

reorderMutate

  • reorderMutate(e, t): void

  • Parameters

    • e: any
    • t: any

    Returns void

replaceId

  • replaceId(e, t): void

  • Parameters

    • e: any
    • t: any

    Returns void

reset

  • reset(): void

  • Returns void

serialize

  • serialize(): any[]

  • Returns any[]

set

slice

  • slice(start?, end?): NoteModel[]

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

some

  • some(predicate, thisArg?): boolean

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

    Parameters

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

        • (value, index, array): unknown

        • Parameters

          Returns unknown

    • 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?): this

  • Parameters

    • Optionaloptions: {
          silent?: boolean;
      }
      • Optionalsilent?: boolean

    Returns this

stopListening

  • stopListening(context?, eventName?, listener?): this

  • Parameters

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

    Returns this

toArray

toJSON

  • toJSON(): any[]

  • Returns any[]

trigger

  • trigger(eventName, ...args): 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
    • Rest...args: any[]

    Returns this

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

unbind

  • unbind(eventName?, listener?, context?): this

  • Alias of off

    Parameters

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

    Returns this

    Alias

    off

updateCollectionFromDB

  • updateCollectionFromDB(a?, b?): any

  • Parameters

    • Optionala: any
    • Optionalb: any

    Returns any

where

  • where(ids): NoteModel[]

  • Parameters

    • ids: Stringable[]

    Returns NoteModel[]

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods