Class SoFetchPromise<T>

constructor

• new SoFetchPromise<T>(
      executor: (
          resolve: (value: T | PromiseLike<T>) => void,
          reject: (reason?: any) => void,
      ) => void,
  ): SoFetchPromise<T>

  Type Parameters

  • T

  Parameters

  • executor: (
        resolve: (value: T | PromiseLike<T>) => void,
        reject: (reason?: any) => void,
    ) => void

  Returns SoFetchPromise<T>

beforeFetchSendHandlers

beforeSendHandlers

catch

errorHandlers

finally

onRequestCompleteHandlers

then

timeout

beforeFetchSend

• beforeFetchSend(
      handler: (
          request: RequestInit,
      ) => void | RequestInit | Promise<void | RequestInit>,
  ): SoFetchPromise<T>

  Adds a handler which allows developers to modify the low-level fetch RequestInit object before the HTTP request is made. These handlers execute after beforeSend handlers. This is useful for one-off occasions when you need to access some aspect of the low-level Fetch API. If you're using this a lot it might make more sense for you to use the Fetch API directly.

  Parameters

  • handler: (request: RequestInit) => void | RequestInit | Promise<void | RequestInit>

  Returns SoFetchPromise<T>

  Example

  //An example of how you might send both files and data in a single request.
     const postFilesAndDataResponse = await soFetch.put<PostFilesAndDataResponse>("https://example.com/files-and-data").beforeFetchSend((init:RequestInit) => {
        const formData = new FormData()
        formData.append("company", "Antoinette");
        formData.append("file1", myFile)
        const headers = {...init.headers} as Record<string,string>
        if (headers["content-type"]) {
            delete headers["content-type"]
        }
        init.body = formData
        init.headers = headers
        return init
     })
  Copy

  See

  For more examples see https://sofetch.antoinette.agency

beforeSend

• beforeSend(
      handler: (
          request: SoFetchRequest,
      ) => void | SoFetchRequest | Promise<void | SoFetchRequest>,
  ): SoFetchPromise<T>

  Adds a handler which will be executed before this HTTP request is sent. BeforeSend handlers added here will will be executed after those added on the config.

  Parameters

  • handler: (
        request: SoFetchRequest,
    ) => void | SoFetchRequest | Promise<void | SoFetchRequest>

  Returns SoFetchPromise<T>

  Example

  await soFetch("https://example.com/users",{name:"Sarah", id:1234}).beforeSend((req:SoFetchRequest) => {
        console.info(`Sending ${req.method} request to URL ${req.url}`
     })
  Copy

  See

  For more examples see https://sofetch.antoinette.agency

catchHTTP

• catchHTTP(
      status: number,
      handler: (response: Response) => void,
  ): SoFetchPromise<T>

  Adds a handler which will be executed on receipt from the server of the specified status code. Multiple handlers will be executed in the order in which they are added. If you add an error handler for a specific status code here any corresponding handlers in the config will not be executed.

  Parameters

  • status: number

    An HTTP status code

  • handler: (response: Response) => void

    A function which accepts a Fetch Response as an argument

  Returns SoFetchPromise<T>

  Example

  const unicorn = await soFetch("https://unicorns.com/1234")
       .catchHttp(404, (res:Response) => {
          console.error("This unicorn can't be found")
      })
  Copy

  See

  For more examples see https://sofetch.antoinette.agency

onRequestComplete

• onRequestComplete(
      handler: (response: Response) => void | Promise<void>,
  ): SoFetchPromise<T>

  Adds a handler which will be executed after this HTTP request is completed. Handlers will fire regardless of whether the response status code indicated an error

  Parameters

  • handler: (response: Response) => void | Promise<void>

  Returns SoFetchPromise<T>

  Example

  await soFetch("https://example.com/users",{name:"Sarah", id:1234}).onRequestComplete((r: Response) => {
        console.info(`Response received from ${r.url} with status ${r.status}`
     })
  Copy

  See

  For more examples see https://sofetch.antoinette.agency

setTimeout

• setTimeout(ms: number): Promise<SoFetchPromise<T>>

  Parameters

  • ms: number

  Returns Promise<SoFetchPromise<T>>