Interface RouterStoreType

history

location

currentRoute

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

  Returns undefined | RouteItem<any, any>

defaultPage

• get defaultPage(): string

  Returns string

fullSearch

• get fullSearch(): SearchObj

  Returns SearchObj

groupTitleKey

• get groupTitleKey(): PageGroups

  Returns PageGroups

menuList

• get menuList(): MenuGroup[]

  Returns MenuGroup[]

routes

• get routes(): BaseRouteItem[]

  Returns BaseRouteItem[]

addRouteDisableCondition

• addRouteDisableCondition<T extends keyof IRouteMeta>(
      key: T,
      condition: DisableRouteCondition,
  ): void

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

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • key: T
  • condition: DisableRouteCondition

  Returns void

clearSearch

• clearSearch(replace?: true): void

  Parameters

  • Optionalreplace: true

  Returns void

clearState

• clearState(replace?: true): void

  Parameters

  • Optionalreplace: true

  Returns void

deleteSearch

• deleteSearch(key: string, replace?: true): void

  Parameters

  • key: string
  • Optionalreplace: true

  Returns void

disableRoute

• disableRoute<T extends keyof IRouteMeta>(key: T): 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

• getCurrentPage(): null | PageComponentType

  Giving the pointer to the current page

  Returns null | PageComponentType

getMatchParams

• getMatchParams(): undefined | Match<any>

  Returns undefined | Match<any>

getRouteDescriptor

• getRouteDescriptor<T extends keyof IRouteMeta>(
      name: T,
  ): undefined | RouteDescriptor<T>

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • name: T

  Returns undefined | RouteDescriptor<T>

getSearch

• getSearch(key: string): undefined | string

  Parameters

  • key: string

  Returns undefined | string

getSearchString

• getSearchString(obj: { [key: string]: string }): string

  Parameters

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

  Returns string

hasRouteAccess

• hasRouteAccess<T extends keyof IRouteMeta>(
      name: T,
      ...params: RouteDescriptorParams<T>,
  ): any

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

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • name: T

    Имя роута
  • ...params: RouteDescriptorParams<T>

    Параметры роута

  Returns any

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

isRouteExist

• isRouteExist<T extends keyof IRouteMeta>(key: T): boolean

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • key: T

  Returns boolean

openTab

• openTab<T extends keyof IRouteMeta>(
      name: T,
      ...param: RouteDescriptorParams<T>,
  ): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • name: T
  • ...param: RouteDescriptorParams<T>

  Returns void

overrideRoute

• overrideRoute<T extends keyof IRouteMeta>(
      key: T,
      route: Partial<IRouteMeta[T]>,
  ): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

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

  Returns void

parseSearch

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

  Parameters

  • search: string
  • Optionalkey: string

  Returns undefined | string | SearchObj

registerRoute

• registerRoute<T extends keyof IRouteMeta>(key: T, route: IRouteMeta[T]): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • key: T
  • route: IRouteMeta[T]

  Returns void

registerRoutes

• registerRoutes(routes: Partial<IRouteMeta>): void

  Parameters

  • routes: Partial<IRouteMeta>

  Returns void

reloadRoutes

• reloadRoutes(): void

  Returns void

removeRouteDisableCondition

• removeRouteDisableCondition<T extends keyof IRouteMeta>(key: T): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • key: T

  Returns void

replaceRoute

• replaceRoute<T extends keyof IRouteMeta>(
      name: T,
      ...param: RouteDescriptorParams<T>,
  ): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • name: T
  • ...param: RouteDescriptorParams<T>

  Returns void

setCurrentPage

• setCurrentPage(page: null | PageComponentType): void

  Remembers the current page instance

  Parameters

  • page: null | PageComponentType

  Returns void

setNewRoute

• setNewRoute(pathname?: string, searchObj?: SearchObj, replace?: true): void

  Parameters

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

  Returns void

setPath

• setPath(path: string, replace?: true): void

  Parameters

  • path: string
  • Optionalreplace: true

  Returns void

setRoute

• setRoute<T extends keyof IRouteMeta>(
      name: T,
      ...param: RouteDescriptorParams<T>,
  ): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • name: T
  • ...param: RouteDescriptorParams<T>

  Returns void

setSearch

• setSearch(obj: { [key: string]: string }, replace?: true): void

  Parameters

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

  Returns void

setSearchItem

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

  Parameters

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

  Returns void

undisableRoute

• undisableRoute<T extends keyof IRouteMeta>(key: T): void

  Type Parameters

  • T extends keyof IRouteMeta

  Parameters

  • key: T

  Returns void

  Deprecated

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

  End Of Support

  @universe-platform/router 2.0.0