PushSubscription.unsubscribe()

The unsubscribe() method of the PushSubscription interface returns a Promise that resolves to a boolean value when the current subscription is successfully unsubscribed.

Syntax

unsubscribe()

Parameters

None.

Return value

A Promise that resolves to a boolean value when the current subscription is successfully unsubscribed.

Examples

navigator.serviceWorker.ready.then((reg) => {
  reg.pushManager.getSubscription().then((subscription) => {
    subscription.unsubscribe().then((successful) => {
      // You've successfully unsubscribed
    }).catch((e) => {
      // Unsubscribing failed
    })
  })
});

Specifications

Specification
Push API
# dom-pushsubscription-unsubscribe

Browser compatibility

BCD tables only load in the browser

See also