Class Model<Collection>

11290

411290 >= 2.2222.8

Type Parameters

Collection = undefined

Hierarchy (View Summary)

Constructors

constructor

new Model<Collection = undefined>(
proterties?: any,
options?: any,
): Model<Collection>
Type Parameters
- Collection = undefined
Parameters
- Optionalproterties: any
- Optionaloptions: any
Returns Model<Collection>
Overrides EventEmitter.constructor
- Defined in src/whatsapp/models/Model.ts:70

Properties

`Optional`collection

collection?: Collection

`Optional`parent

parent?: any

proxyName

proxyName: string

`Static` `Optional`allowedIds

allowedIds?: any[]

`Static` `Optional`idClass

idClass?: any

`Static`Proxy

Proxy: string

Methods

addChild

addChild(id: Stringable, context: { [key: string]: any }): void
Parameters
- id: Stringable
- context: { [key: string]: any }
Returns void
- Defined in src/whatsapp/models/Model.ts:80

bind

bind(eventName: Event, listener: Listener, context?: any): this
Alias of on
Parameters
- eventName: Event
- listener: Listener
- Optionalcontext: any
Returns this
Alias
on
Inherited from EventEmitter.bind
- Defined in src/whatsapp/misc/EventEmitter.ts:99

clear

clear(): void
Returns void
- Defined in src/whatsapp/models/Model.ts:90

decObservers

decObservers(): void
Returns void
- Defined in src/whatsapp/models/Model.ts:76

delete

delete(): void
Returns void
- Defined in src/whatsapp/models/Model.ts:92

emit

emit(eventName: Event, ...args: any[]): this
Alias of trigger
Parameters
- eventName: Event
- ...args: any[]
Returns this
Alias
trigger
Inherited from EventEmitter.emit
- Defined in src/whatsapp/misc/EventEmitter.ts:120

get

get<T extends keyof Model<Collection>>(attr: T): Model<Collection>[T]
Type Parameters
- T extends keyof Model<Collection>
Parameters
- attr: T
Returns Model<Collection>[T]
- Defined in src/whatsapp/models/Model.ts:82

getDefault

getDefault<T extends keyof Model<Collection>>(attr: T): any
Type Parameters
- T extends keyof Model<Collection>
Parameters
- attr: T
Returns any
- Defined in src/whatsapp/models/Model.ts:96

hasObservers

hasObservers(): boolean
Returns boolean
- Defined in src/whatsapp/models/Model.ts:78

hasUnfiredChanges

hasUnfiredChanges(): boolean
Returns boolean
- Defined in src/whatsapp/models/Model.ts:86

incObservers

incObservers(e?: boolean): void
Parameters
- Optionale: boolean
Returns void
- Defined in src/whatsapp/models/Model.ts:74

initialize

initialize(): void
Returns void
- Defined in src/whatsapp/models/Model.ts:72

isListening

isListening(eventName: Event): boolean
Parameters
- eventName: Event
Returns boolean
Inherited from EventEmitter.isListening
- Defined in src/whatsapp/misc/EventEmitter.ts:93

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
Inherited from EventEmitter.listenTo
- Defined in src/whatsapp/misc/EventEmitter.ts:77

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
Inherited from EventEmitter.listenToAndRun
- Defined in src/whatsapp/misc/EventEmitter.ts:91

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
Inherited from EventEmitter.listenToOnce
- Defined in src/whatsapp/misc/EventEmitter.ts:84

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.
Inherited from EventEmitter.off
- Defined in src/whatsapp/misc/EventEmitter.ts:62

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.
Inherited from EventEmitter.on
- Defined in src/whatsapp/misc/EventEmitter.ts:42

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.
Inherited from EventEmitter.once
- Defined in src/whatsapp/misc/EventEmitter.ts:52

removeAllListeners

removeAllListeners(): this
Removes all listeners.

Returns this
Returns a reference to the EventEmitter, so that calls can be chained.
Inherited from EventEmitter.removeAllListeners
- Defined in src/whatsapp/misc/EventEmitter.ts:115

removeListener

removeListener(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from EventEmitter.removeListener
- Defined in src/whatsapp/misc/EventEmitter.ts:110

reset

reset(): void
Returns void
- Defined in src/whatsapp/models/Model.ts:94

set

set(...args: any): any
Parameters
- ...args: any
Returns any
- Defined in src/whatsapp/models/Model.ts:84

stopListening

stopListening(context?: any, eventName?: Event, listener?: Listener): this
Parameters
- Optionalcontext: any
- OptionaleventName: Event
- Optionallistener: Listener
Returns this
Inherited from EventEmitter.stopListening
- Defined in src/whatsapp/misc/EventEmitter.ts:70

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.
Inherited from EventEmitter.trigger
- Defined in src/whatsapp/misc/EventEmitter.ts:68

unbind

unbind(eventName?: Event, listener?: Listener, context?: any): this
Alias of off
Parameters
- OptionaleventName: Event
- Optionallistener: Listener
- Optionalcontext: any
Returns this
Alias
off
Inherited from EventEmitter.unbind
- Defined in src/whatsapp/misc/EventEmitter.ts:105

unset

unset(ids: Stringable | Stringable[], t?: any): void
Parameters
- ids: Stringable | Stringable[]
- Optionalt: any
Returns void
- Defined in src/whatsapp/models/Model.ts:88

`Static`isIdType

isIdType(e: any): boolean
Parameters
- e: any
Returns boolean
- Defined in src/whatsapp/models/Model.ts:100

Class Model<Collection>

Whatsapp

Whatsapp

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Model<Collection>

Properties

Optionalcollection

Optionalparent

proxyName

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

Methods

addChild

Parameters

Returns void

bind

Parameters

Returns this

Alias

clear

Returns void

decObservers

Returns void

delete

Returns void

emit

Parameters

Returns this

Alias

get

Type Parameters

Parameters

Returns Model<Collection>[T]

getDefault

Type Parameters

Parameters

Returns any

hasObservers

Returns boolean

hasUnfiredChanges

Returns boolean

incObservers

Parameters

Returns void

initialize

Returns void

isListening

Parameters

Returns boolean

listenTo

Parameters

Returns this

listenToAndRun

Parameters

Returns this

listenToOnce

Parameters

Returns this

off

Parameters

Returns this

on

Parameters

Returns this

once

Parameters

Returns this

removeAllListeners

Returns this

removeListener

`Optional`collection

`Optional`parent

`Static` `Optional`allowedIds

`Static` `Optional`idClass

`Static`Proxy

`Static`isIdType