busy

A generic display and progress for things that take time
noseglid
240,139
Flag as spam or malicious

Busy (as always!)

An indicator which let's you know some background tasks is currently being run.

busy gif

API

In your package.json

  "consumedServices": {
    "busy": {
      "versions": {
        "^1.0.0": "consumeBusy"
      }
    }
  }

Consume the provided registry

consumeBusy(registry) {
  this.busyRegistry = registry;
}

begin(identifier, text)

Call when a long running task has begun.

this.busyRegistry.begin('packageName.uniqueIdentifier', 'Description of long running task');
  • identifier: A unique identifier, prefixed with your package name to avoid collisions.
  • text: Text describing the long running task. Displayed when hovering the busy-wheel.

end(identifier[, success])

Call to signal that the long running task has ended

this.busyRegistry.end('packageName.uniqueIdentifier')
  • identifier: The identifier of the task specified when calling begin.
  • success: Whether the operation succeeded or not. Default true.

Integrations

Feel free to add your integration to this list