Chartbreaker
    Preparing search index...

    Interface NavigationHistoryEntry

    The NavigationHistoryEntry interface of the Navigation API represents a single navigation history entry.

    MDN Reference

    interface NavigationHistoryEntry {
        id: string;
        index: number;
        key: string;
        ondispose: null | ((this: NavigationHistoryEntry, ev: Event) => any);
        sameDocument: boolean;
        url: null | string;
        addEventListener<K extends "dispose">(
            type: K,
            listener: (
                this: NavigationHistoryEntry,
                ev: NavigationHistoryEntryEventMap[K],
            ) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        getState(): any;
        removeEventListener<K extends "dispose">(
            type: K,
            listener: (
                this: NavigationHistoryEntry,
                ev: NavigationHistoryEntryEventMap[K],
            ) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
    }

    Hierarchy

    • EventTarget
      • NavigationHistoryEntry
    Index

    Properties

    id index key ondispose sameDocument url

    Methods

    addEventListener dispatchEvent getState removeEventListener

    Properties

    id: string

    The id read-only property of the NavigationHistoryEntry interface returns the id of the history entry, or an empty string if current document is not fully active.

    MDN Reference

    index: number

    The index read-only property of the NavigationHistoryEntry interface returns the index of the history entry in the history entries list (that is, the list returned by Navigation.entries()), or -1 if the entry does not appear in the list or if current document is not fully active.

    MDN Reference

    key: string

    The key read-only property of the NavigationHistoryEntry interface returns the key of the history entry, or an empty string if current document is not fully active.

    MDN Reference

    ondispose: null | ((this: NavigationHistoryEntry, ev: Event) => any)

    MDN Reference

    sameDocument: boolean

    The sameDocument read-only property of the NavigationHistoryEntry interface returns true if this history entry is for the same document as the current Document value and current document is fully active, or false otherwise.

    MDN Reference

    url: null | string

    The url read-only property of the NavigationHistoryEntry interface returns the absolute URL of this history entry.

    MDN Reference

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • The getState() method of the NavigationHistoryEntry interface returns a clone of the developer-supplied state associated with this history entry.

      MDN Reference

      Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods