Cvent | cvent

Hierarchy

Cvent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Cvent(target?: EventTarget): Cvent

- Defined in cvent.ts:22
Parameters
- Default value target: EventTarget = globalThis
Returns Cvent

Properties

Private canIUseNative

canIUseNative: boolean

Private debounceEventListeners

debounceEventListeners: Record<string, IFireEvent> | null

Private eventListeners

eventListeners: IEventListener | null

Private target

target: EventTarget | null

Private throttleEventListeners

throttleEventListeners: Record<string, IFireEvent> | null

Static Private defaultMaxListeners

defaultMaxListeners: number = 10

Static Private instance

instance: Cvent | null

Methods

destroy

destroy(): void

- Defined in cvent.ts:222
off all events, clear all caches

Returns void

emit

emit(event: string | string[], payload?: any): Cvent

- Defined in cvent.ts:148
emit events Support multiple events(Strings are separated by commas or array of strings)

Parameters
- event: string | string[]
  
  Multiple names of events to be dispatched
- Default value payload: any = null
  
  Event handler
Returns Cvent

emitDebounce

emitDebounce(event: string | string[], payload?: any, __namedParameters?: { leading: undefined | false | true; trailing: undefined | false | true; wait: undefined | number }): Cvent

- Defined in cvent.ts:166
emit events by debounce Support multiple events(Strings are separated by commas or array of strings)

Parameters
- event: string | string[]
  
  Multiple event name to be dispatched
- Default value payload: any = null
  
  Datas to be dispatched
- Default value __namedParameters: { leading: undefined | false | true; trailing: undefined | false | true; wait: undefined | number } = {}
  - leading: undefined | false | true
  - trailing: undefined | false | true
  - wait: undefined | number
Returns Cvent

emitThrottle

emitThrottle(event: string | string[], payload?: any, __namedParameters?: { leading: undefined | false | true; trailing: undefined | false | true; wait: undefined | number }): Cvent

- Defined in cvent.ts:196
emit events by throttle Support multiple events(Strings are separated by commas or array of strings)

Parameters
- event: string | string[]
  
  Multiple event name to be dispatched
- Default value payload: any = null
  
  Datas to be dispatched
- Default value __namedParameters: { leading: undefined | false | true; trailing: undefined | false | true; wait: undefined | number } = {}
  - leading: undefined | false | true
  - trailing: undefined | false | true
  - wait: undefined | number
Returns Cvent

Private fireEvent

fireEvent(ev: string, payload: any): void

- Defined in cvent.ts:250
Real logic of single event to be dispatched

Parameters
- ev: string
  
  Single event name
- payload: any
  
  Datas to be dispatched
Returns void

getMaxListeners

getMaxListeners(): number

- Defined in cvent.ts:237
Returns number

off

off(event: string | string[], eventlistener?: ICustomEventListener): Cvent

- Defined in cvent.ts:106
cancel events Support multiple events(Strings are separated by commas or array of strings) Support to cancel a type of event (only pass the event name, not pass the event processing function)

Parameters
- event: string | string[]
  
  Multiple names of events to be canceled
- Optional eventlistener: ICustomEventListener
  
  Event handler
Returns Cvent

on

on(event: string | string[], eventlistener: ICustomEventListener, options?: IOnOptions): Cvent

- Defined in cvent.ts:50
register events Support multiple events(Strings are separated by commas or array of strings)

Parameters
- event: string | string[]
  
  Multiple names of events to be registered
- eventlistener: ICustomEventListener
  
  Event handler
- Default value options: IOnOptions = { once: false }
Returns Cvent

once

once(event: string | string[], eventlistener: ICustomEventListener): Cvent

- Defined in cvent.ts:95
register events will to be called once Support multiple events(Strings are separated by commas or array of strings)

Parameters
- event: string | string[]
- eventlistener: ICustomEventListener
Returns Cvent

setMaxListeners

setMaxListeners(maxListeners: number): void

- Defined in cvent.ts:241
Parameters
- maxListeners: number
Returns void

Static getInstance

getInstance(target?: EventTarget): Cvent

- Defined in cvent.ts:36
Support return singleton

Parameters
- Default value target: EventTarget = globalThis
Returns Cvent

Generated using TypeDoc