Interface IRequest

A SuperTest Request object with some helper functions.

Hierarchy

  • Test

    Hierarchy

    • IRequest

Properties

[toStringTag] app? bearer cookies json method url

Methods

abort accept agent attach auth buffer ca catch cert clearTimeout disableTLSCerts end expect field finally get http2 key maxResponseSize ok on parse part pfx pipe query redirects responseType retry send serialize serverAddress set then timeout trustLocalhost type unset use withCredentials write

Properties

Readonly [toStringTag]

[toStringTag]: string

Optional app

app?: any

bearer

bearer: ((token: string) => IRequest)

Type declaration

    • (token: string): IRequest

    • Helper function that adds an authorization header with value 'Bearer '.

      Parameters

      • token: string

        The bearer token to add.

      Returns IRequest

cookies

cookies: string

json

json: (() => IRequest)

Type declaration

    • (): IRequest

    • Helper function that sets the Accept header to 'application/json'.

      Returns IRequest

method

method: string

url

url: string

Methods

abort

  • Returns void

accept

  • Parameters

    • type: string

    Returns IRequest

agent

  • Parameters

    • Optional agent: Agent

    Returns IRequest

attach

  • Parameters

    • field: string
    • file: MultipartValueSingle
    • Optional options: string | { contentType?: string; filename?: string }

    Returns IRequest

auth

  • Parameters

    • user: string
    • pass: string
    • Optional options: { type: "basic" | "auto" }
      • type: "basic" | "auto"

    Returns IRequest

  • Parameters

    • token: string
    • options: { type: "bearer" }
      • type: "bearer"

    Returns IRequest

buffer

  • Parameters

    • Optional val: boolean

    Returns IRequest

ca

  • Parameters

    • cert: string | Buffer | Buffer[] | string[]

    Returns IRequest

catch

  • Attaches a callback for only the rejection of the Promise.

    Returns

    A Promise for the completion of the callback.

    Type Parameters

    Type Parameters

    • TResult = never

    Parameters

    • Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<Response | TResult>

cert

  • Parameters

    • cert: string | Buffer | Buffer[] | string[]

    Returns IRequest

clearTimeout

  • Returns IRequest

disableTLSCerts

  • Returns IRequest

end

  • Parameters

    • Optional callback: CallbackHandler

    Returns IRequest

expect

  • Parameters

    • status: number
    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • status: number
    • body: any
    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • checker: ((res: Response) => any)
        • (res: Response): any

        • Parameters

          • res: Response

          Returns any

    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • body: string
    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • body: RegExp
    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • body: Object
    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • field: string
    • val: string
    • Optional callback: CallbackHandler

    Returns IRequest

  • Parameters

    • field: string
    • val: RegExp
    • Optional callback: CallbackHandler

    Returns IRequest

field

  • Parameters

    • name: string
    • val: MultipartValue

    Returns IRequest

  • Parameters

    • fields: { [fieldName: string]: MultipartValue }
      • [fieldName: string]: MultipartValue

    Returns IRequest

finally

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Returns

    A Promise for the completion of the callback.

    Parameters

    • Optional onfinally: null | (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<Response>

get

  • Parameters

    • field: string

    Returns string

http2

  • Parameters

    • Optional enable: boolean

    Returns IRequest

key

  • Parameters

    • cert: string | Buffer | Buffer[] | string[]

    Returns IRequest

maxResponseSize

  • Parameters

    • size: number

    Returns IRequest

ok

  • Parameters

    • callback: ((res: Response) => boolean)
        • (res: Response): boolean

        • Parameters

          • res: Response

          Returns boolean

    Returns IRequest

on

  • Parameters

    • name: "error"
    • handler: ((err: any) => void)
        • (err: any): void

        • Parameters

          • err: any

          Returns void

    Returns IRequest

  • Parameters

    • name: "progress"
    • handler: ((event: ProgressEvent) => void)
        • (event: ProgressEvent): void

        • Parameters

          • event: ProgressEvent

          Returns void

    Returns IRequest

  • Parameters

    • name: "response"
    • handler: ((response: Response) => void)
        • (response: Response): void

        • Parameters

          • response: Response

          Returns void

    Returns IRequest

  • Parameters

    • name: string
    • handler: ((event: any) => void)
        • (event: any): void

        • Parameters

          • event: any

          Returns void

    Returns IRequest

parse

  • Parameters

    • parser: Parser

    Returns IRequest

part

  • Returns IRequest

pfx

  • Parameters

    • cert: string | Buffer | Buffer[] | string[] | { passphrase: string; pfx: string | Buffer }

    Returns IRequest

pipe

  • Parameters

    • stream: WritableStream
    • Optional options: object

    Returns Writable

query

  • Parameters

    • val: string | object

    Returns IRequest

redirects

  • Parameters

    • n: number

    Returns IRequest

responseType

  • Parameters

    • type: string

    Returns IRequest

retry

  • Parameters

    • Optional count: number
    • Optional callback: CallbackHandler

    Returns IRequest

send

  • Parameters

    • Optional data: string | object

    Returns IRequest

serialize

  • Parameters

    • serializer: Serializer

    Returns IRequest

serverAddress

  • Parameters

    • app: any
    • path: string

    Returns string

set

  • Parameters

    • field: object

    Returns IRequest

  • Parameters

    • field: string
    • val: string

    Returns IRequest

  • Parameters

    • field: "Cookie"
    • val: string[]

    Returns IRequest

then

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Returns

    A Promise for the completion of which ever callback is executed.

    Type Parameters

    Type Parameters

    • TResult1 = Response

    • TResult2 = never

    Parameters

    • Optional onfulfilled: null | ((value: Response) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

timeout

  • Parameters

    • ms: number | { deadline?: number; response?: number }

    Returns IRequest

trustLocalhost

  • Parameters

    • Optional enabled: boolean

    Returns IRequest

type

  • Parameters

    • val: string

    Returns IRequest

unset

  • Parameters

    • field: string

    Returns IRequest

use

  • Parameters

    • fn: Plugin

    Returns IRequest

withCredentials

  • Returns IRequest

write

  • Parameters

    • data: string | Buffer
    • Optional encoding: string

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc