Interface IRequest

Hierarchy

Promise<IResponse>
- IRequest
  - Test

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IRequest(method: string, url: string): IRequest

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:107
Initialize a new Request with the given method and url.

Parameters
- method: string
- url: string
Returns IRequest

Properties

cookies

cookies: string

method

method: string

url

url: string

Methods

abort

abort(): void

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:122
Returns void

accept

accept(type: string): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:123
Parameters
- type: string
Returns this

agent

agent(agent?: any): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:116
Parameters
- Optional agent: any
Returns this

attach

attach(field: string, file: MultipartValueSingle, options?: string | { contentType?: string; filename?: string }): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:124
Parameters
- field: string
- file: MultipartValueSingle
- Optional options: string | { contentType?: string; filename?: string }
Returns this

auth

auth(user: string, pass: string, options?: { type: "basic" | "auto" }): this
auth(token: string, options: { type: "bearer" }): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:129
Parameters
- user: string
- pass: string
- Optional options: { type: "basic" | "auto" }
  - type: "basic" | "auto"
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:130
Parameters
- token: string
- options: { type: "bearer" }
  - type: "bearer"
Returns this

buffer

buffer(val?: boolean): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:131
Parameters
- Optional val: boolean
Returns this

ca

ca(cert: any | any[]): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:132
Parameters
- cert: any | any[]
Returns this

catch

catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<IResponse | TResult>

Inherited from IRequest.catch
- Defined in opt/hostedtoolcache/node/20.17.0/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1448
Attaches a callback for only the rejection of the Promise.

Type parameters
- TResult = never
Parameters
- Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null
  
  The callback to execute when the Promise is rejected.
Returns Promise<IResponse | TResult>

A Promise for the completion of the callback.

cert

cert(cert: any | any[]): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:133
Parameters
- cert: any | any[]
Returns this

clearTimeout

clearTimeout(): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:134
Returns this

disableTLSCerts

disableTLSCerts(): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:135
Returns this

end

end(callback?: CallbackHandler): void

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:136
Parameters
- Optional callback: CallbackHandler
Returns void

field

field(name: string, val: MultipartValue): this
field(fields: {}): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:137
Parameters
- name: string
- val: MultipartValue
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:138
Parameters
- fields: {}
  - [fieldName: string]: MultipartValue
Returns this

get

get(field: string): string

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:139
Parameters
- field: string
Returns string

http2

http2(enable?: boolean): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:140
Parameters
- Optional enable: boolean
Returns this

key

key(cert: any | any[]): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:141
Parameters
- cert: any | any[]
Returns this

maxResponseSize

maxResponseSize(size: number): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:172
Parameters
- size: number
Returns this

ok

ok(callback: (res: IResponse) => boolean): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:142
Parameters
- callback: (res: IResponse) => boolean
  - - (res: IResponse): boolean
    - Parameters
      - res: IResponse
      Returns boolean
Returns this

on

on(name: "error", handler: (err: any) => void): this
on(name: "progress", handler: (event: ProgressEvent) => void): this
on(name: "response", handler: (response: IResponse) => void): this
on(name: string, handler: (event: any) => void): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:143
Parameters
- name: "error"
- handler: (err: any) => void
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:144
Parameters
- name: "progress"
- handler: (event: ProgressEvent) => void
  - - (event: ProgressEvent): void
    - Parameters
      - event: ProgressEvent
      Returns void
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:145
Parameters
- name: "response"
- handler: (response: IResponse) => void
  - - (response: IResponse): void
    - Parameters
      - response: IResponse
      Returns void
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:146
Parameters
- name: string
- handler: (event: any) => void
  - - (event: any): void
    - Parameters
      - event: any
      Returns void
Returns this

parse

parse(parser: Parser): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:147
Parameters
- parser: Parser
Returns this

part

part(): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:148
Returns this

pfx

pfx(cert: any | any[] | { passphrase: string; pfx: string | any }): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:149
Parameters
- cert: any | any[] | { passphrase: string; pfx: string | any }
Returns this

pipe

pipe(stream: any, options?: object): any

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:155
Parameters
- stream: any
- Optional options: object
Returns any

query

query(val: object | string): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:156
Parameters
- val: object | string
Returns this

redirects

redirects(n: number): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:157
Parameters
- n: number
Returns this

responseType

responseType(type: string): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:158
Parameters
- type: string
Returns this

retry

retry(count?: number, callback?: CallbackHandler): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:159
Parameters
- Optional count: number
- Optional callback: CallbackHandler
Returns this

send

send(data?: string | object): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:160
Parameters
- Optional data: string | object
Returns this

serialize

serialize(serializer: Serializer): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:161
Parameters
- serializer: Serializer
Returns this

set

set(field: object): this
set(field: string, val: string): this
set(field: "Cookie", val: string[]): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:162
Parameters
- field: object
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:163
Parameters
- field: string
- val: string
Returns this
- Defined in home/runner/work/superdeno/superdeno/src/test.ts:164
Parameters
- field: "Cookie"
- val: string[]
Returns this

then

then<TResult1, TResult2>(onfulfilled?: ((value: IResponse) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>

Inherited from IRequest.then
- Defined in opt/hostedtoolcache/node/20.17.0/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1441
Attaches callbacks for the resolution and/or rejection of the Promise.

Type parameters
- TResult1 = IResponse
- TResult2 = never
Parameters
- Optional onfulfilled: ((value: IResponse) => TResult1 | PromiseLike<TResult1>) | undefined | null
  
  The callback to execute when the Promise is resolved.
- Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
  
  The callback to execute when the Promise is rejected.
Returns Promise<TResult1 | TResult2>

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

timeout

timeout(ms: number | { deadline?: number; response?: number }): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:165
Parameters
- ms: number | { deadline?: number; response?: number }
Returns this

trustLocalhost

trustLocalhost(enabled?: boolean): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:166
Parameters
- Optional enabled: boolean
Returns this

type

type(val: string): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:167
Parameters
- val: string
Returns this

unset

unset(field: string): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:168
Parameters
- field: string
Returns this

use

use(fn: Plugin): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:169
Parameters
- fn: Plugin
Returns this

withCredentials

withCredentials(): this

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:170
Returns this

write

write(data: string | any, encoding?: string): boolean

- Defined in home/runner/work/superdeno/superdeno/src/test.ts:171
Parameters
- data: string | any
- Optional encoding: string
Returns boolean

Generated using TypeDoc