Type alias SubscriptionOptions

SubscriptionOptions: {
    behavior?: WaitForSync;
    name?: string;
    throwOnUpdate?: boolean;
    timeout?: number;
}

Type declaration

  • Optional behavior?: WaitForSync

    Specifies how to wait or not wait for subscribed objects to be downloaded.

    Default

    WaitForSync.FirstTime
    
  • Optional name?: string

    Sets the name of the subscription being added. This allows you to later refer to the subscription by name, e.g. when calling MutableSubscriptionSet.removeByName.

  • Optional throwOnUpdate?: boolean

    By default, adding a subscription with the same name as an existing one but a different query will update the existing subscription with the new query. If throwOnUpdate is set to true, adding a subscription with the same name but a different query will instead throw an exception. Adding a subscription with the same name and query is always a no-op.

  • Optional timeout?: number

    The maximum time (in milliseconds) to wait for objects to be downloaded. If the time exceeds this limit, the Results is returned and the download continues in the background.

Generated using TypeDoc