Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JQueryPromise<T>

Interface for the JQuery promise, part of callbacks

Type parameters

  • T

Hierarchy

Index

Methods

always

done

fail

pipe

  • pipe(doneFilter?: function, failFilter?: function, progressFilter?: function): JQueryPromise<any>
  • Parameters

    • Optional doneFilter: function
        • (x: any): any
        • Parameters

          • x: any

          Returns any

    • Optional failFilter: function
        • (x: any): any
        • Parameters

          • x: any

          Returns any

    • Optional progressFilter: function
        • (x: any): any
        • Parameters

          • x: any

          Returns any

    Returns JQueryPromise<any>

progress

state

  • state(): string
  • Determine the current state of a Deferred object.

    Returns string

then

  • then<U>(doneFilter: function, failFilter?: function, progressFilter?: function): JQueryPromise<U>
  • then(doneFilter: function, failFilter?: function, progressFilter?: function): JQueryPromise<void>
  • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

    Type parameters

    • U

    Parameters

    • doneFilter: function

      A function that is called when the Deferred is resolved.

        • Parameters

          • Optional value: T
          • Rest ...values: any[]

          Returns U | JQueryPromise<U>

    • Optional failFilter: function

      An optional function that is called when the Deferred is rejected.

        • (...reasons: any[]): any
        • Parameters

          • Rest ...reasons: any[]

          Returns any

    • Optional progressFilter: function
        • (...progression: any[]): any
        • Parameters

          • Rest ...progression: any[]

          Returns any

    Returns JQueryPromise<U>

  • Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

    Parameters

    • doneFilter: function

      A function that is called when the Deferred is resolved.

        • (value?: T, ...values: any[]): void
        • Parameters

          • Optional value: T
          • Rest ...values: any[]

          Returns void

    • Optional failFilter: function

      An optional function that is called when the Deferred is rejected.

        • (...reasons: any[]): any
        • Parameters

          • Rest ...reasons: any[]

          Returns any

    • Optional progressFilter: function
        • (...progression: any[]): any
        • Parameters

          • Rest ...progression: any[]

          Returns any

    Returns JQueryPromise<void>

Generated using TypeDoc