@jupyterlab/application 0.19.1-alpha.0 → 0.19.1

package/lib/router.d.ts

@@ -1,204 +1,204 @@
-import { CommandRegistry } from '@phosphor/commands';
-import { ReadonlyJSONObject, Token } from '@phosphor/coreutils';
-import { IDisposable } from '@phosphor/disposable';
-import { ISignal } from '@phosphor/signaling';
-/**
- * The URL Router token.
- */
-export declare const IRouter: Token<IRouter>;
-/**
- * A static class that routes URLs within the application.
- */
-export interface IRouter {
-    /**
-     * The base URL for the router.
-     */
-    readonly base: string;
-    /**
-     * The command registry used by the router.
-     */
-    readonly commands: CommandRegistry;
-    /**
-     * The parsed current URL of the application.
-     */
-    readonly current: IRouter.ILocation;
-    /**
-     * A signal emitted when the router routes a route.
-     */
-    readonly routed: ISignal<IRouter, IRouter.ILocation>;
-    /**
-     * If a matching rule's command resolves with the `stop` token during routing,
-     * no further matches will execute.
-     */
-    readonly stop: Token<void>;
-    /**
-     * Navigate to a new path within the application.
-     *
-     * @param path - The new path or empty string if redirecting to root.
-     *
-     * @param options - The navigation options.
-     */
-    navigate(path: string, options?: IRouter.INavOptions): void;
-    /**
-     * Register a rule that maps a path pattern to a command.
-     *
-     * @param options - The route registration options.
-     *
-     * @returns A disposable that removes the registered rule from the router.
-     */
-    register(options: IRouter.IRegisterOptions): IDisposable;
-    /**
-     * Cause a hard reload of the document.
-     */
-    reload(): void;
-    /**
-     * Route a specific path to an action.
-     *
-     * @param url - The URL string that will be routed.
-     *
-     * #### Notes
-     * If a pattern is matched, its command will be invoked with arguments that
-     * match the `IRouter.ILocation` interface.
-     */
-    route(url: string): void;
-}
-/**
- * A namespace for the `IRouter` specification.
- */
-export declare namespace IRouter {
-    /**
-     * The parsed location currently being routed.
-     */
-    interface ILocation extends ReadonlyJSONObject {
-        /**
-         * The location hash.
-         */
-        hash: string;
-        /**
-         * The path that matched a routing pattern.
-         */
-        path: string;
-        /**
-         * The request being routed with the router `base` omitted.
-         *
-         * #### Notes
-         * This field includes the query string and hash, if they exist.
-         */
-        request: string;
-        /**
-         * The search element, including leading question mark (`'?'`), if any,
-         * of the path.
-         */
-        search: string;
-    }
-    /**
-     * The options passed into a navigation request.
-     */
-    interface INavOptions {
-        /**
-         * Whether the navigation should be hard URL change instead of an HTML
-         * history API change.
-         */
-        hard?: boolean;
-        /**
-         * Whether the navigation should be added to the browser's history.
-         */
-        silent?: boolean;
-    }
-    /**
-     * The specification for registering a route with the router.
-     */
-    interface IRegisterOptions {
-        /**
-         * The command string that will be invoked upon matching.
-         */
-        command: string;
-        /**
-         * The regular expression that will be matched against URLs.
-         */
-        pattern: RegExp;
-        /**
-         * The rank order of the registered rule. A lower rank denotes a higher
-         * priority. The default rank is `100`.
-         */
-        rank?: number;
-    }
-}
-/**
- * A static class that routes URLs within the application.
- */
-export declare class Router implements IRouter {
-    /**
-     * Create a URL router.
-     */
-    constructor(options: Router.IOptions);
-    /**
-     * The base URL for the router.
-     */
-    readonly base: string;
-    /**
-     * The command registry used by the router.
-     */
-    readonly commands: CommandRegistry;
-    /**
-     * Returns the parsed current URL of the application.
-     */
-    readonly current: IRouter.ILocation;
-    /**
-     * A signal emitted when the router routes a route.
-     */
-    readonly routed: ISignal<this, IRouter.ILocation>;
-    /**
-     * If a matching rule's command resolves with the `stop` token during routing,
-     * no further matches will execute.
-     */
-    readonly stop: Token<void>;
-    /**
-     * Navigate to a new path within the application.
-     *
-     * @param path - The new path or empty string if redirecting to root.
-     *
-     * @param options - The navigation options.
-     */
-    navigate(path: string, options?: IRouter.INavOptions): void;
-    /**
-     * Register to route a path pattern to a command.
-     *
-     * @param options - The route registration options.
-     *
-     * @returns A disposable that removes the registered rule from the router.
-     */
-    register(options: IRouter.IRegisterOptions): IDisposable;
-    /**
-     * Cause a hard reload of the document.
-     */
-    reload(): void;
-    /**
-     * Route a specific path to an action.
-     *
-     * #### Notes
-     * If a pattern is matched, its command will be invoked with arguments that
-     * match the `IRouter.ILocation` interface.
-     */
-    route(): void;
-    private _routed;
-    private _rules;
-}
-/**
- * A namespace for `Router` class statics.
- */
-export declare namespace Router {
-    /**
-     * The options for instantiating a JupyterLab URL router.
-     */
-    interface IOptions {
-        /**
-         * The fully qualified base URL for the router.
-         */
-        base: string;
-        /**
-         * The command registry used by the router.
-         */
-        commands: CommandRegistry;
-    }
-}
+import { CommandRegistry } from '@phosphor/commands';
+import { ReadonlyJSONObject, Token } from '@phosphor/coreutils';
+import { IDisposable } from '@phosphor/disposable';
+import { ISignal } from '@phosphor/signaling';
+/**
+ * The URL Router token.
+ */
+export declare const IRouter: Token<IRouter>;
+/**
+ * A static class that routes URLs within the application.
+ */
+export interface IRouter {
+    /**
+     * The base URL for the router.
+     */
+    readonly base: string;
+    /**
+     * The command registry used by the router.
+     */
+    readonly commands: CommandRegistry;
+    /**
+     * The parsed current URL of the application.
+     */
+    readonly current: IRouter.ILocation;
+    /**
+     * A signal emitted when the router routes a route.
+     */
+    readonly routed: ISignal<IRouter, IRouter.ILocation>;
+    /**
+     * If a matching rule's command resolves with the `stop` token during routing,
+     * no further matches will execute.
+     */
+    readonly stop: Token<void>;
+    /**
+     * Navigate to a new path within the application.
+     *
+     * @param path - The new path or empty string if redirecting to root.
+     *
+     * @param options - The navigation options.
+     */
+    navigate(path: string, options?: IRouter.INavOptions): void;
+    /**
+     * Register a rule that maps a path pattern to a command.
+     *
+     * @param options - The route registration options.
+     *
+     * @returns A disposable that removes the registered rule from the router.
+     */
+    register(options: IRouter.IRegisterOptions): IDisposable;
+    /**
+     * Cause a hard reload of the document.
+     */
+    reload(): void;
+    /**
+     * Route a specific path to an action.
+     *
+     * @param url - The URL string that will be routed.
+     *
+     * #### Notes
+     * If a pattern is matched, its command will be invoked with arguments that
+     * match the `IRouter.ILocation` interface.
+     */
+    route(url: string): void;
+}
+/**
+ * A namespace for the `IRouter` specification.
+ */
+export declare namespace IRouter {
+    /**
+     * The parsed location currently being routed.
+     */
+    interface ILocation extends ReadonlyJSONObject {
+        /**
+         * The location hash.
+         */
+        hash: string;
+        /**
+         * The path that matched a routing pattern.
+         */
+        path: string;
+        /**
+         * The request being routed with the router `base` omitted.
+         *
+         * #### Notes
+         * This field includes the query string and hash, if they exist.
+         */
+        request: string;
+        /**
+         * The search element, including leading question mark (`'?'`), if any,
+         * of the path.
+         */
+        search: string;
+    }
+    /**
+     * The options passed into a navigation request.
+     */
+    interface INavOptions {
+        /**
+         * Whether the navigation should be hard URL change instead of an HTML
+         * history API change.
+         */
+        hard?: boolean;
+        /**
+         * Whether the navigation should be added to the browser's history.
+         */
+        silent?: boolean;
+    }
+    /**
+     * The specification for registering a route with the router.
+     */
+    interface IRegisterOptions {
+        /**
+         * The command string that will be invoked upon matching.
+         */
+        command: string;
+        /**
+         * The regular expression that will be matched against URLs.
+         */
+        pattern: RegExp;
+        /**
+         * The rank order of the registered rule. A lower rank denotes a higher
+         * priority. The default rank is `100`.
+         */
+        rank?: number;
+    }
+}
+/**
+ * A static class that routes URLs within the application.
+ */
+export declare class Router implements IRouter {
+    /**
+     * Create a URL router.
+     */
+    constructor(options: Router.IOptions);
+    /**
+     * The base URL for the router.
+     */
+    readonly base: string;
+    /**
+     * The command registry used by the router.
+     */
+    readonly commands: CommandRegistry;
+    /**
+     * Returns the parsed current URL of the application.
+     */
+    readonly current: IRouter.ILocation;
+    /**
+     * A signal emitted when the router routes a route.
+     */
+    readonly routed: ISignal<this, IRouter.ILocation>;
+    /**
+     * If a matching rule's command resolves with the `stop` token during routing,
+     * no further matches will execute.
+     */
+    readonly stop: Token<void>;
+    /**
+     * Navigate to a new path within the application.
+     *
+     * @param path - The new path or empty string if redirecting to root.
+     *
+     * @param options - The navigation options.
+     */
+    navigate(path: string, options?: IRouter.INavOptions): void;
+    /**
+     * Register to route a path pattern to a command.
+     *
+     * @param options - The route registration options.
+     *
+     * @returns A disposable that removes the registered rule from the router.
+     */
+    register(options: IRouter.IRegisterOptions): IDisposable;
+    /**
+     * Cause a hard reload of the document.
+     */
+    reload(): void;
+    /**
+     * Route a specific path to an action.
+     *
+     * #### Notes
+     * If a pattern is matched, its command will be invoked with arguments that
+     * match the `IRouter.ILocation` interface.
+     */
+    route(): void;
+    private _routed;
+    private _rules;
+}
+/**
+ * A namespace for `Router` class statics.
+ */
+export declare namespace Router {
+    /**
+     * The options for instantiating a JupyterLab URL router.
+     */
+    interface IOptions {
+        /**
+         * The fully qualified base URL for the router.
+         */
+        base: string;
+        /**
+         * The command registry used by the router.
+         */
+        commands: CommandRegistry;
+    }
+}