Class WebPush

constructor

• new WebPush(config: WebPushConfig): WebPush

  Parameters

  • config: WebPushConfig

  Returns WebPush

Readonlyconfig

generateRequest

• generateRequest(
      subscription: PushSubscription,
      payload?:
          | string
          | Buffer<ArrayBufferLike>
          | Uint8Array<ArrayBufferLike>
          | null,
      options?: GenerateRequestOptions,
  ): WebPushRequestDetails

  Generate the request (endpoint + fetch init) to send a push message.

  • For aes128gcm, this produces an RFC8188 payload body (header block + encrypted records).
  • For Web Push, defaults to a single record per RFC8291; multi-record requires allowMultipleRecords: true.

  Parameters

  • subscription: PushSubscription
  • Optionalpayload: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | null
  • Optionaloptions: GenerateRequestOptions

  Returns WebPushRequestDetails

notify

• notify(
      subscription: PushSubscription,
      payload?:
          | string
          | Buffer<ArrayBufferLike>
          | Uint8Array<ArrayBufferLike>
          | null,
      options?: GenerateRequestOptions & { throwOnInvalidResponse?: boolean },
  ): Promise<Response>

  Method to send notification to subscribed device

  Parameters

  • subscription: PushSubscription
  • Optionalpayload: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | null
  • Optionaloptions: GenerateRequestOptions & { throwOnInvalidResponse?: boolean }

  Returns Promise<Response>