@docsvision/webclient/System/IRouteInfo.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { RouteType } from "@docsvision/webclient/System/RouteType";
import { RouteSemantics } from '@docsvision/webclient/System/RouteSemantics';
/** Информация о роута и его оперативные данные. */
export interface IRouteInfo<T> {
    routeSemantics: RouteSemantics;
    /** Уникальный идентификатор тип роута, определяющий его структуру данных. */
    routeType: RouteType;
    /**
     * Значение, которое позволяет отличить один роут от другого при одном и том же routeType.
     * Значение представляет собой некоторую строку, которая вычисляется на основе
     * существенных параметров роута. Например, в роуте папки существенным параметром
     * является id папки, т.к. при его смене необходимо закрыть текущую папку и открыть другую.
     */
    identity: string;
    /** Оперативные данные роута. */
    data: T;
    /** Флаг, свидетельствующий о том что пользователь запросил отмену обработки роута. */
    cancelRequested?: boolean;
    /** Флаг, свидетельствующий о том, что роут был размонтирован. */
    unmounted?: boolean;
    /** Если флаг установлен, то роут не будет сохранен в истории браузера. */
    temporary?: boolean;
}