@nextcloud/upload
    Preparing search index...

    Interface Eta

    SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors SPDX-License-Identifier: AGPL-3.0-or-later

    interface Eta {
        addEventListener: <T extends "pause" | "reset" | "resume" | "update">(
            type: T,
            listener: TypedEventListenerOrEventListenerObject<EtaEventsMap, T> | null,
            options?: boolean | AddEventListenerOptions,
        ) => void;
        dispatchEvent: (event: Event) => boolean;
        removeEventListener: <T extends "pause" | "reset" | "resume" | "update">(
            type: T,
            callback: TypedEventListenerOrEventListenerObject<EtaEventsMap, T> | null,
            options?: boolean | EventListenerOptions,
        ) => void;
        get progress(): number;
        get speed(): number;
        get speedReadable(): string;
        get status(): EtaStatus;
        get time(): number;
        get timeReadable(): string;
        add(done: number): void;
        dispatchTypedEvent<T extends keyof EtaEventsMap>(
            _type: T,
            event: EtaEventsMap[T],
        ): boolean;
        pause(): void;
        reset(): void;
        resume(): void;
        update(done: number, total?: number): void;
    }

    Hierarchy

    Index

    Properties

    addEventListener dispatchEvent removeEventListener

    Accessors

    progress speed speedReadable status time timeReadable

    Methods

    add dispatchTypedEvent pause reset resume update

    Properties

    addEventListener: <T extends "pause" | "reset" | "resume" | "update">(
        type: T,
        listener: TypedEventListenerOrEventListenerObject<EtaEventsMap, T> | null,
        options?: boolean | AddEventListenerOptions,
    ) => void

    Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    dispatchEvent: (event: Event) => boolean

    Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    To ensure type safety use dispatchTypedEvent instead.

    removeEventListener: <T extends "pause" | "reset" | "resume" | "update">(
        type: T,
        callback: TypedEventListenerOrEventListenerObject<EtaEventsMap, T> | null,
        options?: boolean | EventListenerOptions,
    ) => void

    Removes the event listener in target's event listener list with the same type, callback, and options.

    Accessors

    • get speed(): number

      Transfer speed in bytes per second. Returns -1 if not yet estimated.

      Returns number

    • get speedReadable(): string

      Get the speed in human readable format using file sizes like 10KB/s. Returns the empty string if not yet estimated.

      Returns string

    • get timeReadable(): string

      Human readable version of the estimated time.

      Returns string

    Methods

    • Add more transferred bytes.

      Parameters

      • done: number

        Additional bytes done.

      Returns void

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      Type Parameters

      Parameters

      Returns boolean

    • Update the transmission state.

      Parameters

      • done: number

        The new value of transferred bytes.

      • Optionaltotal: number

        Optionally also update the total bytes we expect.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods