External module "http/index"

Index

Interfaces

HTTPRequestResult

Type aliases

Variables

Functions

Type aliases

HTTPRequestBody

HTTPRequestBody: string | Buffer | ReadableStream

A possible value for a HTTP request body.

HTTPRequestOptions

HTTPRequestOptions: RequestOptions | RequestOptions

HTTP(s) request options.

HTTPRequestURL

HTTPRequestURL: string | vscode.Uri | Url

A possible value for a HTTP request URL.

Variables

Const MergeDeep

MergeDeep: any = require('merge-deep')

Const NormalizeHeaderCase

NormalizeHeaderCase: any = require("header-case-normalizer")

Functions

DELETE

DELETE(url: HTTPRequestURL, body?: HTTPRequestBody, headers?: any, opts?: HTTPRequestOptions): Promise<HTTPRequestResult>

- Defined in http/index.ts:88
Does a HTTP 'DELETE' request.

Parameters
- url: HTTPRequestURL
  
  The URL.
- Optional body: HTTPRequestBody
- Optional headers: any
- Optional opts: HTTPRequestOptions
Returns Promise<HTTPRequestResult>

The promsie with the HTTP response / result.

GET

GET(url: HTTPRequestURL, headers?: any, opts?: HTTPRequestOptions): Promise<HTTPRequestResult>

- Defined in http/index.ts:101
Does a HTTP 'GET' request.

Parameters
- url: HTTPRequestURL
  
  The URL.
- Optional headers: any
- Optional opts: HTTPRequestOptions
Returns Promise<HTTPRequestResult>

The promsie with the HTTP response / result.

PATCH

PATCH(url: HTTPRequestURL, body?: HTTPRequestBody, headers?: any, opts?: HTTPRequestOptions): Promise<HTTPRequestResult>

- Defined in http/index.ts:115
Does a HTTP 'PATCH' request.

Parameters
- url: HTTPRequestURL
  
  The URL.
- Optional body: HTTPRequestBody
- Optional headers: any
- Optional opts: HTTPRequestOptions
Returns Promise<HTTPRequestResult>

The promsie with the HTTP response / result.

POST

POST(url: HTTPRequestURL, body?: HTTPRequestBody, headers?: any, opts?: HTTPRequestOptions): Promise<HTTPRequestResult>

- Defined in http/index.ts:129
Does a HTTP 'POST' request.

Parameters
- url: HTTPRequestURL
  
  The URL.
- Optional body: HTTPRequestBody
- Optional headers: any
- Optional opts: HTTPRequestOptions
Returns Promise<HTTPRequestResult>

The promsie with the HTTP response / result.

PUT

PUT(url: HTTPRequestURL, body?: HTTPRequestBody, headers?: any, opts?: HTTPRequestOptions): Promise<HTTPRequestResult>

- Defined in http/index.ts:143
Does a HTTP 'PUT' request.

Parameters
- url: HTTPRequestURL
  
  The URL.
- Optional body: HTTPRequestBody
- Optional headers: any
- Optional opts: HTTPRequestOptions
Returns Promise<HTTPRequestResult>

The promsie with the HTTP response / result.

request

request(method: string, url: HTTPRequestURL, body?: HTTPRequestBody, headers?: any, opts?: HTTPRequestOptions): Promise<HTTPRequestResult>

- Defined in http/index.ts:158
Does a HTTP request.

Parameters
- method: string
  
  The method to use.
- url: HTTPRequestURL
  
  The URL.
- Optional body: HTTPRequestBody
- Optional headers: any
- Optional opts: HTTPRequestOptions
Returns Promise<HTTPRequestResult>

The promsie with the HTTP response / result.

Generated using TypeDoc