Interface IOptions

An options object for initializing a the workspaces model.

interface IOptions {
    auto?: boolean;
    manager: Workspace.IManager;
    refreshInterval?: number;
    refreshStandby?: Standby | (() => boolean | Standby);
}

Index

Properties

auto? manager refreshInterval? refreshStandby?

Properties

`Optional` auto

auto?: boolean

Whether a to automatically loads initial list of workspaces. The default is true.

manager

manager: Workspace.IManager

The workspaces manager.

`Optional` refreshInterval

refreshInterval?: number

The time interval for browser refreshing, in ms.

`Optional` refreshStandby

refreshStandby?: Standby | (() => boolean | Standby)

When the model stops polling the API. Defaults to when-hidden.

Type declaration

- (): boolean | Standby
- Returns boolean | Standby