Interface EventsChannel

interface EventsChannel {
    close(): void;
    publish(event, pubOptions?): Promise<any>;
    subscribe(observer, subOptions?): Subscription;
}

Methods

close publish subscribe

Methods

close

  • close(): void
  • Experimental

    API may change in future versions

    Close channel and any active subscriptions

    Returns void

    Example

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

    channel.close()

publish

  • publish(event, pubOptions?): Promise<any>
  • Experimental

    API may change in future versions

    Publish events to a channel via WebSocket

    Parameters

    • event: DocumentType

      JSON-serializable value or an array of values

    • Optional pubOptions: EventsOptions

      request overrides: authMode, authToken

    Returns Promise<any>

    void on success

    Example

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

    await channel.publish({ some: "data" });

    Example

    // event batching
    await channel.publish("default/channel", [{ some: "event" }, { some: "event2" }])

    Example

    // authMode override
    await channel.publish({ some: "data" }, { authMode: "userPool" });

    Throws

    on error

subscribe

  • subscribe(observer, subOptions?): Subscription
  • Experimental

    API may change in future versions

    Subscribe to Events

    Parameters

    Returns Subscription

    Example

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

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

    Example

    // authMode override
    channel.subscribe({
      next: (data) => { console.log(data) },
      error: (err) => { console.error(err) },
    }, { authMode: 'userPool' })

Settings

Member Visibility

Theme

On This Page