Interface History

Public

interface History {
    action: Action;
    length: number;
    location: Location;
    block(prompt?: string | boolean | ((location: Location, action: Action) => string | false | void)): (() => void);
    createHref(location: Universe.Platform.Router.LocationDescriptorObject): string;
    go(n: number): void;
    goBack(): void;
    goForward(): void;
    listen(listener: ((location: Location, action: Action) => void)): (() => void);
    push(location: LocationDescriptor, state?: unknown): void;
    replace(location: LocationDescriptor, state?: unknown): void;
}

Properties

action length location

Methods

block createHref go goBack goForward listen push replace

Properties

action

action: Action

length

length: number

location

location: Location

Methods

block

  • block(prompt?): (() => void)

  • Parameters

    • Optionalprompt: string | boolean | ((location: Location, action: Action) => string | false | void)

    Returns (() => void)

      • (): void

      • Returns void

createHref

go

  • go(n): void

  • Parameters

    • n: number

    Returns void

goBack

  • goBack(): void

  • Returns void

goForward

  • goForward(): void

  • Returns void

listen

  • listen(listener): (() => void)

  • Parameters

    Returns (() => void)

      • (): void

      • Returns void

push

  • push(location, state?): void

  • Parameters

    Returns void

replace

  • replace(location, state?): void

  • Parameters

    Returns void

On This Page

Properties
Methods