Class ChatstateCollection

constructor

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

  Parameters

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

  Returns ChatstateCollection

findFirst

modelClass

Staticcomparator

Staticmodel

length

• get length(): number

  Returns number

add

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

  Parameters

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

  Returns ChatstateModel | ChatstateModel[]

assertGet

• assertGet(e: Stringable): ChatstateModel

  Parameters

  • e: Stringable

  Returns ChatstateModel

at

• at(position: number): ChatstateModel

  Parameters

  • position: number

  Returns ChatstateModel

bind

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

  Alias of on

  Parameters

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

  Returns this

  Alias

  on

emit

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

  Alias of trigger

  Parameters

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

  Returns this

  Alias

  trigger

every

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

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

  Type Parameters

  • S extends ChatstateModel

  Parameters

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

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

  Parameters

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

  Parameters

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

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

  Parameters

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

forEach

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

  Performs the specified action for each element in an array.

  Parameters

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

get

• get(e: Stringable): ChatstateModel

  Parameters

  • e: Stringable

  Returns ChatstateModel

getModelsArray

• getModelsArray(): ChatstateModel[]

  Returns ChatstateModel[]

head

• head(): ChatstateModel

  Returns ChatstateModel

includes

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

  Parameters

  • model: ChatstateModel
  • Optionalposition: number

  Returns boolean

indexOf

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

    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: Event): boolean

  Parameters

  • eventName: Event

  Returns boolean

isModel

• isModel(model: any): model is ChatstateModel

  Parameters

  • model: any

  Returns model is ChatstateModel

last

• last(): ChatstateModel

  Returns ChatstateModel

lastIndexOf

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

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

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

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

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

  Parameters

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

  Returns ChatstateModel

• reduce<U>(
      callbackfn: (
          previousValue: U,
          currentValue: ChatstateModel,
          currentIndex: number,
          array: ChatstateModel[],
      ) => 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: ChatstateModel,
        currentIndex: number,
        array: ChatstateModel[],
    ) => 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: ChatstateModel | ChatstateModel[],
      options?: { index?: boolean; silent?: boolean },
  ): ChatstateModel[]

  Parameters

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

  Returns ChatstateModel[]

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): ChatstateModel[]

  Parameters

  • e: number
  • t: number

  Returns ChatstateModel[]

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

serialize

• serialize(): any[]

  Returns any[]

set

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

  Parameters

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

  Returns ChatstateModel | ChatstateModel[]

slice

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

  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 ChatstateModel[]

some

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

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

  Parameters

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

  Returns ChatstateModel[]

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

where

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

  Parameters

  • ids: Stringable[]

  Returns ChatstateModel[]