Type Alias: RequestOptions

RequestOptions: object & Pick<https.RequestOptions, "pfx" | "passphrase" | "agent">

Type declaration

optional auth: string

The authentication credentials to use for the request.

Format: username:password

optional body: object | string

optional downloadFile: string

Path of downloading a file from the server.

await request('https://example.com', { downloadFile: 'filepath' })

optional downloadStream: NodeJS.WritableStream

Create a write stream to download a file.

import { createWriteStream } from 'fs'

const stream = createWriteStream('filepath')
await request('https://example.com', { downloadStream: stream })

optional file: string

Path of uploading a file to the server.

await request('https://example.com', { file: 'filepath' })

optional headers: OutgoingHttpHeaders

optional logger: Logger

optional method: string

The HTTP method to use when making the request. Defaults to GET.

optional parse: (body) => any

Body parser. Defaults to JSON.parse.

• body: string

any

optional query: object

[key: string]: any

optional timeout: number

Timeout in milliseconds,