Search
    Preparing search index...

    Interface History

    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<unknown>, state?: unknown): void;
        replace(location: LocationDescriptor<unknown>, state?: unknown): void;
    }
    Index

    Properties

    action length location

    Methods

    block createHref go goBack goForward listen push replace

    Properties

    action: Action

    Действие выполняемое при работе с историей

    length: number

    Количество записей в истории

    location: Location

    Текущее положение в истории

    Methods

    • Блокирует или задает пользовательское подтверждение при изменении истории.

      Parameters

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

        Настраиваемое подтверждение или функция обратного вызова.

      Returns () => void

    • Переходит на указанное количество записей в истории.

      Parameters

      • n: number

        Количество шагов (положительное или отрицательное).

      Returns void

    • Переходит на предыдущую запись в истории.

      Returns void

    • Переходит на следующую запись в истории.

      Returns void

    • Добавляет слушатель изменений в истории.

      Parameters

      • listener: (location: Location, action: Action) => void

        Функция, вызываемая при смене состояния.

      Returns () => void

    • Добавляет новую запись в историю.

      Parameters

      • location: LocationDescriptor<unknown>

        Путь или объект параметров.

      • Optionalstate: unknown

        Дополнительное состояние.

      Returns void

    • Заменяет текущую запись в истории.

      Parameters

      • location: LocationDescriptor<unknown>

        Путь или объект параметров.

      • Optionalstate: unknown

        Дополнительное состояние.

      Returns void

    On This Page

    Properties
    Methods