Function connect

connect(
    ctx: AmplifyContext,
    channel: string,
    options?: EventsOptions,
): Promise<EventsChannel>
Parameters
- ctx: AmplifyContext
- channel: string
- Optionaloptions: EventsOptions
Returns Promise<EventsChannel>

connect(channel: string, options?: EventsOptions): Promise<EventsChannel>

Experimental

API may change in future versions

Establish a WebSocket connection to an Events channel

Parameters

channel: string
channel path; <namespace>/<channel>
Optionaloptions: EventsOptions
request overrides: authMode, authToken

Returns Promise<EventsChannel>

Example

const channel = await events.connect("default/channel")

channel.subscribe({
  next: (data) => { console.log(data) },
  error: (err) => { console.error(err) },
})

Example

// authMode override
const channel = await events.connect("default/channel", { authMode: "userPool" })

Example

// with explicit context
const channel = await events.connect(ctx, "default/channel")

Function connect

Parameters

Returns Promise<EventsChannel>

Parameters

Returns Promise<EventsChannel>

Example

Example

Example

Settings