Interface RouterStoreType

Public

interface RouterStoreType {
    history: History;
    location: Location;
    get currentRoute(): undefined | RouteItem<any, any>;
    get defaultPage(): string;
    get fullSearch(): SearchObj;
    get groupTitleKey(): PageGroups;
    get menuList(): MenuGroup[];
    get routes(): BaseRouteItem[];
    addRouteDisableCondition<T>(key: T, condition: DisableRouteCondition): void;
    clearSearch(replace?: true): void;
    clearState(replace?: true): void;
    deleteSearch(key: string, replace?: true): void;
    disableRoute<T>(key: T): void;
    getCurrentPage(): null | PageComponentType;
    getMatchParams(): undefined | Match<any>;
    getRouteDescriptor<T>(name: T): undefined | RouteDescriptor<T>;
    getSearch(key: string): undefined | string;
    getSearchString(obj: {
        [key: string]: string;
    }): string;
    hasRouteAccess<T>(name: T, ...params: RouteDescriptorParams<T>): any;
    isRouteExist<T>(key: T): boolean;
    openTab<T>(name: T, ...param: RouteDescriptorParams<T>): void;
    overrideRoute<T>(key: T, route: Partial<IRouteMeta[T]>): void;
    parseSearch(search: string, key?: string): undefined | string | SearchObj;
    registerRoute<T>(key: T, route: IRouteMeta[T]): void;
    registerRoutes(routes: Partial<IRouteMeta>): void;
    reloadRoutes(): void;
    removeRouteDisableCondition<T>(key: T): void;
    replaceRoute<T>(name: T, ...param: RouteDescriptorParams<T>): void;
    setCurrentPage(page: null | PageComponentType): void;
    setNewRoute(pathname?: string, searchObj?: SearchObj, replace?: true): void;
    setPath(path: string, replace?: true): void;
    setRoute<T>(name: T, ...param: RouteDescriptorParams<T>): void;
    setSearch(obj: {
        [key: string]: string;
    }, replace?: true): void;
    setSearchItem(key: string, value: string, replace?: true): void;
    undisableRoute<T>(key: T): void;
}

Properties

history location

Accessors

currentRoute defaultPage fullSearch groupTitleKey menuList routes

Methods

addRouteDisableCondition clearSearch clearState deleteSearch disableRoute getCurrentPage getMatchParams getRouteDescriptor getSearch getSearchString hasRouteAccess isRouteExist openTab overrideRoute parseSearch registerRoute registerRoutes reloadRoutes removeRouteDisableCondition replaceRoute setCurrentPage setNewRoute setPath setRoute setSearch setSearchItem undisableRoute

Properties

history

history: History

location

location: Location

Accessors

currentRoute

  • get currentRoute(): undefined | RouteItem<any, any>

  • Returns undefined | RouteItem<any, any>

defaultPage

  • get defaultPage(): string

  • Returns string

fullSearch

groupTitleKey

menuList

routes

Methods

addRouteDisableCondition

  • addRouteDisableCondition<T>(key, condition): void

  • Метод для отключения определенных роутов по переданному условию. Рекомендуется использовать этот метод только при инициации приложения Отключение роутов происходит в reloadRoutes

    Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    Returns void

clearSearch

  • clearSearch(replace?): void

  • Parameters

    • Optionalreplace: true

    Returns void

clearState

  • clearState(replace?): void

  • Parameters

    • Optionalreplace: true

    Returns void

deleteSearch

  • deleteSearch(key, replace?): void

  • Parameters

    • key: string
    • Optionalreplace: true

    Returns void

disableRoute

  • disableRoute<T>(key): void

  • Method for disable some routes in extended app's This method will delete route from route list, so you couldn't use deleted route in future You should call this method only in bootstrap of application in "initRouter" method (Unidata.initRouter)

    Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • key: T

    Returns void

    Deprecated

    Для отключения/включения роутов необходимо использовать addRouteDisableCondition и removeRouteDisableCondition

    End Of Support

    @universe-platform/router 2.0.0

getCurrentPage

getMatchParams

  • getMatchParams(): undefined | Match<any>

  • Returns undefined | Match<any>

getRouteDescriptor

  • getRouteDescriptor<T>(name): undefined | RouteDescriptor<T>

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • name: T

    Returns undefined | RouteDescriptor<T>

getSearch

  • getSearch(key): undefined | string

  • Parameters

    • key: string

    Returns undefined | string

getSearchString

  • getSearchString(obj): string

  • Parameters

    • obj: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns string

hasRouteAccess

  • hasRouteAccess<T>(name, ...params): any

  • Метод проверки прав на переданный роут с параметрами

    Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    Returns any

    Возвращает boolean значение доступности роута текущему пользователю. Если роута не существует или у роута отсутсвует routeAccessor будет возвращен true

isRouteExist

  • isRouteExist<T>(key): boolean

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • key: T

    Returns boolean

openTab

  • openTab<T>(name, ...param): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    Returns void

overrideRoute

  • overrideRoute<T>(key, route): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • key: T
    • route: Partial<IRouteMeta[T]>

    Returns void

parseSearch

  • parseSearch(search, key?): undefined | string | SearchObj

  • Parameters

    • search: string
    • Optionalkey: string

    Returns undefined | string | SearchObj

registerRoute

  • registerRoute<T>(key, route): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • key: T
    • route: IRouteMeta[T]

    Returns void

registerRoutes

  • registerRoutes(routes): void

  • Parameters

    • routes: Partial<IRouteMeta>

    Returns void

reloadRoutes

  • reloadRoutes(): void

  • Returns void

removeRouteDisableCondition

  • removeRouteDisableCondition<T>(key): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • key: T

    Returns void

replaceRoute

  • replaceRoute<T>(name, ...param): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    Returns void

setCurrentPage

  • setCurrentPage(page): void

  • Remembers the current page instance

    Parameters

    Returns void

setNewRoute

  • setNewRoute(pathname?, searchObj?, replace?): void

  • Parameters

    • Optionalpathname: string
    • OptionalsearchObj: SearchObj
    • Optionalreplace: true

    Returns void

setPath

  • setPath(path, replace?): void

  • Parameters

    • path: string
    • Optionalreplace: true

    Returns void

setRoute

  • setRoute<T>(name, ...param): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    Returns void

setSearch

  • setSearch(obj, replace?): void

  • Parameters

    • obj: {
          [key: string]: string;
      }
      • [key: string]: string
    • Optionalreplace: true

    Returns void

setSearchItem

  • setSearchItem(key, value, replace?): void

  • Parameters

    • key: string
    • value: string
    • Optionalreplace: true

    Returns void

undisableRoute

  • undisableRoute<T>(key): void

  • Type Parameters

    • T extends keyof IRouteMeta

    Parameters

    • key: T

    Returns void

    Deprecated

    Для отключения/включения роутов необходимо использовать addRouteDisableCondition и removeRouteDisableCondition

    End Of Support

    @universe-platform/router 2.0.0

On This Page

Properties
Accessors
Methods