Interface MandeInstance

Object returned by mande

interface MandeInstance {
    options: Required<Pick<OptionsRaw<ResponseAsTypes>, "headers">> & Omit<
        OptionsRaw<ResponseAsTypes>,
        "headers",
    >;
    delete<T = unknown, R extends ResponseAsTypes = "json">(
        options?: Options<R>,
    ): MandeResponse<T, R>;
    delete<T = unknown, R extends ResponseAsTypes = "json">(
        url: string | number,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    get<T = unknown, R extends ResponseAsTypes = "json">(
        options?: Options<R>,
    ): MandeResponse<T, R>;
    get<T = unknown, R extends ResponseAsTypes = "json">(
        url: string | number,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    patch<T = unknown, R extends ResponseAsTypes = "json">(
        data?: any,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    patch<T = unknown, R extends ResponseAsTypes = "json">(
        url: string | number,
        data?: any,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    post<T = unknown, R extends ResponseAsTypes = "json">(
        data?: any,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    post<T = unknown, R extends ResponseAsTypes = "json">(
        url: string | number,
        data?: any,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    put<T = unknown, R extends ResponseAsTypes = "json">(
        data?: any,
        options?: Options<R>,
    ): MandeResponse<T, R>;
    put<T = unknown, R extends ResponseAsTypes = "json">(
        url: string | number,
        data?: any,
        options?: Options<R>,
    ): MandeResponse<T, R>;
}

Index

Properties

options

Methods

delete get patch post put

Properties

options

options: Required<Pick<OptionsRaw<ResponseAsTypes>, "headers">> & Omit<
OptionsRaw<ResponseAsTypes>,
"headers",
>

Writable options.

Methods

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()
```
- Defined in src/mande.ts:211
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')
```
- Defined in src/mande.ts:224

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()
```
- Defined in src/mande.ts:93
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')
```
- Defined in src/mande.ts:107

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' })
```
- Defined in src/mande.ts:184
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' })
```
- Defined in src/mande.ts:196

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' })
```
- Defined in src/mande.ts:122
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' })
```
- Defined in src/mande.ts:137

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' })
```
- Defined in src/mande.ts:153
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' })
```
- Defined in src/mande.ts:168

Interface MandeInstance

Index

Properties

Methods

Properties

options

Methods

delete

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

get

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

patch

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

post

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

put

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

Type Parameters

Parameters

Returns MandeResponse<T, R>

Example

Settings

On This Page