Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoutingSystem

RoutingSystem provides for core, other systems and modules registration of routes and hashtag routes.

see

https://github.com/collboard/collboard/issues/97 TODO: What about #hash routes

collboard-system

Hierarchy

  • AbstractSystem
    • RoutingSystem

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • systems: ISystemsExtended

    Returns RoutingSystem

Properties

Readonly originalUrl

originalUrl: URL

Original url from startup of the application Note: Collboard normalizes URL and this method is a way how to get the original query params and other things in the URL

Readonly ready

ready: Promise<void>

Promise which is resolved when the system is initialized and ready to use.

Private storageSystem

storageSystem: any

Protected Readonly systems

systems: ISystemsExtended

Readonly urlVariables

urlVariables: BrowserHistoryUrlStorage<RemoveIndex<IUrlVariables>>

Readonly viewUriId

viewUriId: BehaviorSubject<null | string>

Readonly viewUrl

viewUrl: Observable<URL>

Accessors

Private home

  • get home(): any

  • Returns any

homeUrl

  • get homeUrl(): URL

  • Returns URL

isDestroyed

  • get isDestroyed(): boolean

  • Is this object destroyed?

    Returns boolean

isReady

  • get isReady(): boolean

  • Checks if the system is initialized and ready to use.

    Returns boolean

selfUrl

  • get selfUrl(): URL

  • Returns URL

Methods

addSubdestroyable

  • addSubdestroyable(...subdestroyable: ITeardownLogic[]): RoutingSystem

  • Binds new registration with itself. This registration/destroyable will be destroyed with this.

    Parameters

    • Rest ...subdestroyable: ITeardownLogic[]

    Returns RoutingSystem

Protected checkIsReady

  • checkIsReady(): void

  • Checks if the system is initialized and ready to use. If not, throws an error. If it is, do nothing.

    Returns void

Protected checkWhetherNotDestroyed

  • checkWhetherNotDestroyed(errorMessage?: string, runBeforeError?: () => void): void

  • Checks, whether the object is not destroyed

    Parameters

    • Optional errorMessage: string

      Message that will replace default one before error

    • Optional runBeforeError: () => void

      Callback runed before error is thrown; typically this can be some logging

        • (): void

        • Returns void

    Returns void

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

Protected init

  • init(): Promise<void>

  • Returns Promise<void>

navigateBoardHome

  • navigateBoardHome(): void

  • TODO: !! Use this in all places

    Returns void

navigateHome

  • navigateHome(): void

  • Returns void

registerQuery

  • registerQuery<TValue>(defaultParams: TValue, options?: Partial<IBrowserHistoryStorageOptions>): IObservableStorage<TValue>

  • TODO: Make this save to history and check that is is working together with urlVariabiles in routingSystem

    Type parameters

    • TValue: IJson

    Parameters

    • defaultParams: TValue
    • Optional options: Partial<IBrowserHistoryStorageOptions>

    Returns IObservableStorage<TValue>

Static isDestroyable

  • isDestroyable(obj: any): obj is IDestroyable

  • Chcek whether the given object is destroyable

    Parameters

    • obj: any

    Returns obj is IDestroyable