Class PusherServer

constructor

• new PusherServer(options: PusherConfigOptions): PusherServer

  Parameters

  • options: PusherConfigOptions

  Returns PusherServer

Static ReadonlyRequestError

Static ReadonlyToken

Static ReadonlyWebHookError

config

• get config(): PusherConfig

  Returns PusherConfig

authenticateUser

• authenticateUser(
      socketId: string,
      userData: { [key: string]: string },
  ): { auth: string; user_data: string }

  Returns a signature for given socket id and user data.

  Parameters

  • socketId: string

    socket id

  • userData: { [key: string]: string }

    user data

  Returns { auth: string; user_data: string }

  authentication signature

authorizeChannel

• authorizeChannel(
      socketId: string,
      channel: string,
      data?: object,
  ): { auth: string; channel_data?: string; shared_secret?: string }

  Returns a signature for given socket id, channel and socket data.

  Parameters

  • socketId: string

    socket id

  • channel: string

    channel name

  • Optionaldata: object

    additional socket data

  Returns { auth: string; channel_data?: string; shared_secret?: string }

  authorization signature

channelSharedSecret

• channelSharedSecret(_channel: string): string

  Parameters

  • _channel: string

  Returns string

createSignedQueryString

• createSignedQueryString(
      options: {
          body?: string;
          method: string;
          params?: { [key: string]: string };
          path: string;
      },
  ): string

  Builds a signed query string that can be used in a request to Pusher.

  Parameters

  • options: {
        body?: string;
        method: string;
        params?: { [key: string]: string };
        path: string;
    }

    • Optionalbody?: string

      request body

    • method: string

      request method

    • Optionalparams?: { [key: string]: string }

      query params

    • path: string

      request path

  Returns string

  signed query string

get

• get(
      options: { params?: { [key: string]: string }; path: string },
  ): Promise<Response>

  Makes a GET request to Pusher, handles the authentication.

  Returns a promise resolving to a response, or rejecting to a RequestError.

  Parameters

  • options: { params?: { [key: string]: string }; path: string }

    • Optionalparams?: { [key: string]: string }

      query params

    • path: string

      request path

  Returns Promise<Response>

  See

  RequestError

post

• post(
      options: {
          body?: unknown;
          params?: { [key: string]: string };
          path: string;
      },
  ): Promise<Response>

  Makes a POST request to Pusher, handles the authentication.

  Returns a promise resolving to a response, or rejecting to a RequestError.

  Parameters

  • options: { body?: unknown; params?: { [key: string]: string }; path: string }

    • Optionalbody?: unknown

      request body

    • Optionalparams?: { [key: string]: string }

      query params

    • path: string

      request path

  Returns Promise<Response>

  See

  RequestError

sendToUser

• sendToUser(userId: string, event: string, data: unknown): Promise<Response>

  Sends an event to a user.

  Event name can be at most 200 characters long.

  Parameters

  • userId: string

    user id

  • event: string

    event name

  • data: unknown

    event data, objects are JSON-encoded

  Returns Promise<Response>

  a promise resolving to a response, or rejecting to a RequestError.

  See

  RequestError

terminateUserConnections

• terminateUserConnections(userId: string): Promise<Response>

  Terminate users's connections.

  Parameters

  • userId: string

    user id

  Returns Promise<Response>

  a promise resolving to a response, or rejecting to a RequestError.

  See

  RequestError

trigger

• trigger(
      channels: string | string[],
      event: string,
      data?: unknown,
      params?: { info?: string; socket_id?: string },
  ): Promise<Response>

  Triggers an event.

  Channel names can contain only characters which are alphanumeric, '_' or '-' and have to be at most 200 characters long.

  Event name can be at most 200 characters long.

  Returns a promise resolving to a response, or rejecting to a RequestError.

  Parameters

  • channels: string | string[]
  • event: string

    event name

  • Optionaldata: unknown

    event data, objects are JSON-encoded

  • Optionalparams: { info?: string; socket_id?: string }

    additional optional request body parameters

    • Optionalinfo?: string

      a comma separate list of attributes to be returned in the response. Experimental, see https://pusher.com/docs/lab#experimental-program

    • Optionalsocket_id?: string

      id of a socket that should not receive the event

  Returns Promise<Response>

  See

  RequestError

triggerBatch

• triggerBatch(batch: { channel: string; data?: string }[]): Promise<Response>

  Parameters

  • batch: { channel: string; data?: string }[]

  Returns Promise<Response>

webhook

• webhook(
      request: { headers: { [key: string]: string }; rawBody: string },
  ): WebHook

  Creates a WebHook object for a given request.

  Parameters

  • request: { headers: { [key: string]: string }; rawBody: string }

    • headers: { [key: string]: string }

      WebHook HTTP headers with lower-case keys

    • rawBody: string

      raw WebHook body

  Returns WebHook