Interface CurlyFunction

Hierarchy

{}
- CurlyFunction

Callable

__call<ResultData>(url: string, options?: CurlyOptions): Promise<CurlyResult<ResultData>>

- Defined in lib/curly.ts:227
EXPERIMENTAL This API can change between minor releases

Async wrapper around the Curl class.

It's also possible to request using a specific http verb directly by using curl.<http-verb>(url: string, options?: CurlyOptions), like:
```
curly.get('https://www.google.com')
```
Type parameters
- ResultData: any = any
  
  You can use this to specify the type of the data property returned from this call.
Parameters
- url: string
- Optional options: CurlyOptions
Returns Promise<CurlyResult<ResultData>>

Index

Properties

Properties

create

create: (defaultOptions?: CurlyOptions) => CurlyFunction

EXPERIMENTAL This API can change between minor releases

This returns a new curly with the specified options set by default.

Type declaration

- (defaultOptions?: CurlyOptions): CurlyFunction
- Parameters
  - Optional defaultOptions: CurlyOptions
  Returns CurlyFunction

defaultResponseBodyParsers

defaultResponseBodyParsers: CurlyResponseBodyParsersProperty

These are the default response body parsers to be used.

By default there are parsers for the following:

application/json
text/*
*

Generated using TypeDoc