Push | @wesjetpkg/realtime

Hierarchy

Push

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Push(channel: RealtimeSubscription, event: string, payload?: {}, timeout?: number): Push

- Defined in lib/push.ts:16
Initializes the Push

Parameters
- channel: RealtimeSubscription
  
  The Channel
- event: string
  
  The event, for example "phx_join"
- Default value payload: {} = {}
  
  The payload, for example {user_id: 123}
  - [key: string]: unknown
- Default value timeout: number = DEFAULT_TIMEOUT
  
  The push timeout in milliseconds
Returns Push

Properties

channel

channel: RealtimeSubscription

The Channel

event

event: string

The event, for example "phx_join"

payload

payload: {}

The payload, for example {user_id: 123}

Type declaration

[key: string]: unknown

recHooks

recHooks: { callback: Function; status: string }[] = []

receivedResp

receivedResp: { response: Function; status: string } | null = null

ref

ref: string = ""

refEvent

refEvent: string | null = null

sent

sent: boolean = false

timeout

timeout: number

The push timeout in milliseconds

timeoutTimer

timeoutTimer: number | undefined = undefined

Methods

Private _cancelRefEvent

_cancelRefEvent(): void

- Defined in lib/push.ts:100
Returns void

Private _cancelTimeout

_cancelTimeout(): void

- Defined in lib/push.ts:108
Returns void

Private _hasReceived

_hasReceived(status: string): null | false | true

- Defined in lib/push.ts:125
Parameters
- status: string
Returns null | false | true

Private _matchReceive

_matchReceive(__namedParameters: { response: Function; status: string }): void

- Defined in lib/push.ts:113
Parameters
- __namedParameters: { response: Function; status: string }
  - response: Function
  - status: string
Returns void

destroy

destroy(): void

- Defined in lib/push.ts:95
Returns void

receive

receive(status: string, callback: Function): this

- Defined in lib/push.ts:61
Parameters
- status: string
- callback: Function
Returns this

resend

resend(timeout: number): void

- Defined in lib/push.ts:33
Parameters
- timeout: number
Returns void

send

send(): void

- Defined in lib/push.ts:43
Returns void

startTimeout

startTimeout(): void

- Defined in lib/push.ts:70
Returns void

trigger

trigger(status: string, response: any): void

- Defined in lib/push.ts:91
Parameters
- status: string
- response: any
Returns void

updatePayload

updatePayload(payload: {}): void

- Defined in lib/push.ts:57
Parameters
- payload: {}
  - [key: string]: unknown
Returns void

Generated using TypeDoc