Interface HistoryManagement<T, N, C>

Type Parameters

  • T extends Record<string, unknown>

  • N extends InnerNamespace<T>

  • C extends Context

Hierarchy

  • HistoryManagement

Properties

context? initialSearch push replace

Properties

Optional Readonly context

context?: C

Readonly initialSearch

initialSearch: (() => string | URLSearchParams)

Type declaration

    • (): string | URLSearchParams

    • the initial search string (e.g. ?query=test), contains the questionsmark

      Returns string | URLSearchParams

Readonly push

push: ((queryObject, namespaces, options?) => Promise<unknown>)

Type declaration

    • (queryObject, namespaces, options?): Promise<unknown>

    • Parameters

      • queryObject: Record<string, string>
      • namespaces: N
      • Optional options: RouterOptions
        Optional

      Returns Promise<unknown>

Readonly replace

replace: ((queryObject, namespaces, options?) => Promise<unknown>)

Type declaration

    • (queryObject, namespaces, options?): Promise<unknown>

    • Parameters

      • queryObject: Record<string, string>
      • namespaces: N
      • Optional options: RouterOptions
        Optional

      Returns Promise<unknown>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc