Interface MandeInstance

options

delete

• delete<T = unknown, R extends ResponseAsTypes = "json">(
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a DELETE request to the base url. This is equivalent to calling delete with an empty string.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  users.delete()
  Copy

• delete<T = unknown, R extends ResponseAsTypes = "json">(
      url: string | number,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a DELETE request to the given url.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • url: string | number

    relative url to send the request to
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  users.delete('2')
  Copy

get

• get<T = unknown, R extends ResponseAsTypes = "json">(
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a GET request to the base url. This is equivalent to calling get with an empty string.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  const userList = await users.get()
  Copy

• get<T = unknown, R extends ResponseAsTypes = "json">(
      url: string | number,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a GET request to the given url.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • url: string | number

    optional relative url to send the request to
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  const userProfile = await users.get('2')
  Copy

patch

• patch<T = unknown, R extends ResponseAsTypes = "json">(
      data?: any,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a PATCH request to the base url. This is equivalent to calling patch with an empty string.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • Optionaldata: any

    optional body of the request
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  users.patch({ name: 'Eduardo' })
  Copy

• patch<T = unknown, R extends ResponseAsTypes = "json">(
      url: string | number,
      data?: any,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a PATCH request to the given url.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • url: string | number
  • Optionaldata: any
  • Optionaloptions: Options<R>

  Returns MandeResponse<T, R>

  Example

  users.patch('2', { name: 'Eduardo' })
  Copy

post

• post<T = unknown, R extends ResponseAsTypes = "json">(
      data?: any,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a POST request to the base url. This is equivalent to calling post with an empty string.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • Optionaldata: any

    optional body of the request
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  const createdUser = await users.post({ name: 'Eduardo' })
  Copy

• post<T = unknown, R extends ResponseAsTypes = "json">(
      url: string | number,
      data?: any,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a POST request to the given url.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • url: string | number

    relative url to send the request to
  • Optionaldata: any

    optional body of the request
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  const createdUser = await users.post('', { name: 'Eduardo' })
  Copy

put

• put<T = unknown, R extends ResponseAsTypes = "json">(
      data?: any,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a PUT request to the base url. This is equivalent to calling put with an empty string.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • Optionaldata: any

    optional body of the request
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  users.put({ name: 'Eduardo' })
  Copy

• put<T = unknown, R extends ResponseAsTypes = "json">(
      url: string | number,
      data?: any,
      options?: Options<R>,
  ): MandeResponse<T, R>

  Sends a PUT request to the given url.

  Type Parameters

  • T = unknown
  • R extends ResponseAsTypes = "json"

  Parameters

  • url: string | number

    relative url to send the request to
  • Optionaldata: any

    optional body of the request
  • Optionaloptions: Options<R>

    optional Options

  Returns MandeResponse<T, R>

  Example

  users.put('2', { name: 'Eduardo' })
  Copy