Class SeamHttpRequest<TResponse, TResponseKey>

constructor

• new SeamHttpRequest<const TResponse, const TResponseKey>(parent, config): SeamHttpRequest<TResponse, TResponseKey>

• Type Parameters

  • const TResponse
  • const TResponseKey extends
        | undefined
        | string
        | number
        | symbol

  Parameters

  • parent: SeamHttpRequestParent
  • config: SeamHttpRequestConfig<TResponseKey>

  Returns SeamHttpRequest<TResponse, TResponseKey>

Readonly[toStringTag]

body

• get body(): unknown

• Returns unknown

method

• get method(): Method

• Returns Method

responseKey

• get responseKey(): TResponseKey

• Returns TResponseKey

url

• get url(): URL

• Returns URL

catch

• catch<TResult>(onrejected?): Promise<TResult | (TResponseKey extends keyof TResponse
      ? TResponse[TResponseKey<TResponseKey>]
      : undefined)>

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

  Type Parameters

  • TResult = never

  Parameters

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

    The callback to execute when the Promise is rejected.

  Returns Promise<TResult | (TResponseKey extends keyof TResponse
      ? TResponse[TResponseKey<TResponseKey>]
      : undefined)>

  A Promise for the completion of the callback.

execute

• execute(): Promise<TResponseKey extends keyof TResponse
      ? TResponse[TResponseKey<TResponseKey>]
      : undefined>

• Returns Promise<TResponseKey extends keyof TResponse
      ? TResponse[TResponseKey<TResponseKey>]
      : undefined>

finally

• finally(onfinally?): Promise<TResponseKey extends keyof TResponse
      ? TResponse[TResponseKey<TResponseKey>]
      : undefined>

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

  Parameters

  • Optionalonfinally: null | (() => void)

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

  Returns Promise<TResponseKey extends keyof TResponse
      ? TResponse[TResponseKey<TResponseKey>]
      : undefined>

  A Promise for the completion of the callback.

then

• then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>

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

  Type Parameters

  • TResult1 = TResponseKey extends keyof TResponse
        ? TResponse[TResponseKey<TResponseKey>]
        : undefined
  • TResult2 = never

  Parameters

  • Optionalonfulfilled: null | ((value: TResponseKey extends keyof TResponse
        ? TResponse[TResponseKey<TResponseKey>]
        : undefined) => TResult1 | PromiseLike<TResult1>)

    The callback to execute when the Promise is resolved.
  • Optionalonrejected: 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.