Interface Subscription

The skeleton of the Subscription class.

interface Subscription {
    id: string;
    onChange: (callback: OnChangeEvent) => Subscription;
    onError: (callback: OnErrorEvent) => Subscription;
    unsubscribe: () => void;
}

Index

Properties

id onChange onError unsubscribe

Properties

id

id: string

The unique id of the subscription.

onChange

onChange: (callback: OnChangeEvent) => Subscription

The event that will trigger the subscription when any location change.

onError

onError: (callback: OnErrorEvent) => Subscription

The event that will trigger the subscription when any error occurs.

unsubscribe

unsubscribe: () => void

The method to unsubscribe subscription.