UNPKG

892 BTypeScriptView Raw
1import { IWindowResolver } from './tokens';
2/**
3 * A concrete implementation of a window name resolver.
4 */
5export declare class WindowResolver implements IWindowResolver {
6 /**
7 * The resolved window name.
8 *
9 * #### Notes
10 * If the `resolve` promise has not resolved, the behavior is undefined.
11 */
12 get name(): string;
13 /**
14 * Resolve a window name to use as a handle among shared resources.
15 *
16 * @param candidate - The potential window name being resolved.
17 *
18 * #### Notes
19 * Typically, the name candidate should be a JupyterLab workspace name or
20 * an empty string if there is no workspace.
21 *
22 * If the returned promise rejects, a window name cannot be resolved without
23 * user intervention, which typically means navigation to a new URL.
24 */
25 resolve(candidate: string): Promise<void>;
26 private _name;
27}