filestack-js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Filestack token that allow pause, resume or cancel given upload

export
class

FsToken

extends

{EventEmitter}

Type parameters

  • EventTypes: string | symbol | {}

Hierarchy

  • EventEmitter
    • FsCancelToken

Index

Interfaces

Properties

Methods

Properties

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event: T, fn: ListenerFn<EventArgs<EventTypes, T>>, context?: any): this

  • Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any

    Returns this

cancel

  • cancel(reason?: string | Error): void

emit

  • emit<T>(event: T, ...args: EventArgs<EventTypes, T>): boolean

  • Calls each of the listeners registered for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • Rest ...args: EventArgs<EventTypes, T>

    Returns boolean

eventNames

  • eventNames(): Array<EventNames<EventTypes>>

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<EventNames<EventTypes>>

listenerCount

  • listenerCount(event: EventNames<EventTypes>): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: EventNames<EventTypes>

    Returns number

listeners

  • listeners<T>(event: T): Array<ListenerFn<EventArgs<EventTypes, T>>>

  • Return the listeners registered for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T

    Returns Array<ListenerFn<EventArgs<EventTypes, T>>>

off

  • off<T>(event: T, fn?: ListenerFn<EventArgs<EventTypes, T>>, context?: any, once?: boolean): this

  • Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • Optional fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event: T, fn: ListenerFn<EventArgs<EventTypes, T>>, context?: any): this

  • Add a listener for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any

    Returns this

once

  • once<T>(event: T, fn: ListenerFn<EventArgs<EventTypes, T>>, context?: any): this

  • Add a one-time listener for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?: EventNames<EventTypes>): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: EventNames<EventTypes>

    Returns this

removeListener

  • removeListener<T>(event: T, fn?: ListenerFn<EventArgs<EventTypes, T>>, context?: any, once?: boolean): this

  • Remove the listeners of a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • Optional fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any
    • Optional once: boolean

    Returns this