Http

constructor

• new Http(host?: string, port?: number, type?: IpAddressType): Http

  Set the server address; default to HTTP if no scheme is given. port 0 preserves the URL port or the protocol's default port.

  Parameters

  hostOptional

  string

  port

  number = 0

  typeOptional

  IpAddressType

  Returns

  Http

  Source & inheritance

Static ReadonlyRequest

Static ReadonlyResponse

sendRequest

• sendRequest(
      request: HttpRequest,
      timeout?: ReadonlyValue,
      verifyServer?: boolean,
      signal?: AbortSignal,
  ): Promise<HttpResponse>

  Send a request snapshot asynchronously and return the complete response, with a body limit of 64 MiB.

  Parameters

  request

  HttpRequest

  Request contents.

  timeout

  ReadonlyValue = Time.Zero

  Total timeout; Time.Zero disables the timeout.

  verifyServer

  boolean = true

  Whether HTTPS verifies the server certificate; defaults to true.

  signalOptional

  AbortSignal

  Optional cancellation signal; cancellation returns ConnectionFailed.

  Returns

  Promise<HttpResponse>

  Source & inheritance

setHost

• setHost(host: string, port?: number, type?: IpAddressType): boolean

  Set the server and optional IP address family, returning whether the address is valid; do not open a network connection.

  Parameters

  host

  string

  port

  number = 0

  typeOptional

  IpAddressType

  Returns

  boolean

  Source & inheritance