Interface ConfigurableRequestFunction

The main interface of 'apprt-request'.

Hierarchy

RequestFunction
- ConfigurableRequestFunction

ConfigurableRequestFunction(url, options?): Promise<any>
A function executing a request function.
Parameters
- url: string
- Optional options: RequestOptions
Returns Promise<any>
- Defined in api.ts:330

Index

Properties

config del get getProxiedUrl post put

Properties

`Readonly` config

config: Config

Provides access to configuration.

`Readonly` del

del: RequestFunction

Executes a DELETE request (sets method=DELETE in the options)

`Readonly` get

get: RequestFunction

Executes a GET request (sets method=GET in the options)

`Readonly` getProxiedUrl

getProxiedUrl: ((url, options?) => string)

Type declaration

- (url, options?): string
- Utility to create a 'proxied' url. By default it returns the input url, if no proxy rule applies. If the flag 'force' is enabled it will wrap the url with the default proxy.
  Parameters
  - url: string
  - Optional options: {
    force?: boolean;
    }
    - Optional force?: boolean
  Returns string

`Readonly` post

post: RequestFunction

Executes a POST request (sets method=POST in the options)

`Readonly` put

put: RequestFunction

Executes a PUT request (sets method=PUT in the options)

Generated using TypeDoc