pnwkit 3.0 - v4.3.0
    Preparing search index...

    Class Subscriptions

    Manages real-time Politics & War subscriptions over a shared Pusher connection.

    Each subscribe() call returns an independent Subscription handle, so a client can watch as many model/event streams as it likes and tear each down individually. On reconnect, every active subscription replays missed events.

    Index
    constructor
    disconnect subscribe unsubscribeAll

    • Stop every active subscription and close the shared Pusher connection.

      Safe to call even if no subscription was ever made. Because the open Pusher socket keeps Node's event loop alive, call this to let a process exit cleanly. The connection is recreated lazily on the next subscribe.

      Returns void

    • Subscribe to a Politics & War event stream.

      Type Parameters

      Parameters

      • options: SubscribeOptions<M, B>

        Model, event, optional filters, and typed onData / onError handlers

      Returns Promise<Subscription<M, B>>

      A Subscription handle; call .unsubscribe() to stop it

      const sub = await pnwkit.subscriptions.subscribe({
        model: "nation",
        event: "update",
        filters: { alliance_id: "1234" },
        onData: (nation) => console.log(nation.id, nation.nation_name),
      });

      // later
      sub.unsubscribe();

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods