Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KeycloakPromise<TSuccess, TError>

Type parameters

  • TSuccess

  • TError

Hierarchy

  • Promise<TSuccess>
    • KeycloakPromise

Index

Properties

Methods

Properties

Readonly [toStringTag]

[toStringTag]: string

Methods

catch

  • catch<TResult>(onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>)): Promise<TSuccess | TResult>

  • Attaches a callback for only the rejection of the Promise.

    Type parameters

    • TResult = never

    Parameters

    • Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TSuccess | TResult>

    A Promise for the completion of the callback.

error

  • Function to call if the promised action throws an error.

    deprecated

    Use .catch() instead.

    Parameters

    Returns KeycloakPromise<TSuccess, TError>

finally

  • finally(onfinally?: null | (() => void)): Promise<TSuccess>

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optional onfinally: null | (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<TSuccess>

    A Promise for the completion of the callback.

success

  • Function to call if the promised action succeeds.

    deprecated

    Use .then() instead.

    Parameters

    Returns KeycloakPromise<TSuccess, TError>

then

  • then<TResult1, TResult2>(onfulfilled?: null | ((value: TSuccess) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type parameters

    • TResult1 = TSuccess

    • TResult2 = never

    Parameters

    • Optional onfulfilled: null | ((value: TSuccess) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Generated using TypeDoc