GitHubJupyter
  • Preparing search index...
  • The search index is not available
@jupyterlab
  • @jupyterlab
  • apputils
  • Notification
  • promise

Function promise

  • promise<
        Pending extends ReadonlyJSONValue = ReadonlyJSONValue,
        Success extends ReadonlyJSONValue = Pending,
        Error extends ReadonlyJSONValue = Pending,
    >(
        promise: Promise<Success>,
        options: IPromiseOptions<Pending, Success, Error>,
    ): string
  • Helper function to show an in-progress notification.

    Notes

    The message will be truncated if longer than 140 characters.

    Type Parameters

    • Pending extends ReadonlyJSONValue = ReadonlyJSONValue
    • Success extends ReadonlyJSONValue = Pending
    • Error extends ReadonlyJSONValue = Pending

    Parameters

    • promise: Promise<Success>

      Promise to wait for

    • options: IPromiseOptions<Pending, Success, Error>

      Options for the in-progress notification

    Returns string

    Notification unique id

    • Defined in packages/apputils/src/notification.ts:470

Settings

Member Visibility

On This Page

Notes
GitHubJupyter
@jupyterlab
  • Loading...

Generated using TypeDoc