Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WindowResolver

A concrete implementation of a window name resolver.

Hierarchy

  • WindowResolver

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _name

_name: any

Accessors

name

  • get name(): string
  • The resolved window name.

    Notes

    If the resolve promise has not resolved, the behavior is undefined.

    Returns string

Methods

resolve

  • resolve(candidate: string): Promise<void>
  • Resolve a window name to use as a handle among shared resources.

    Parameters

    • candidate: string

      The potential window name being resolved.

      Notes

      Typically, the name candidate should be a JupyterLab workspace name or an empty string if there is no workspace.

      If the returned promise rejects, a window name cannot be resolved without user intervention, which typically means navigation to a new URL.

    Returns Promise<void>

Generated using TypeDoc