Packages

c

io.scalajs.nodejs.http

RequestOptions

class RequestOptions extends Object

Client Request Options

Annotations
@RawJSType() @ScalaJSDefined()
See also

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RequestOptions(protocol: UndefOr[String] = js.undefined, host: UndefOr[String] = js.undefined, hostname: UndefOr[String] = js.undefined, family: UndefOr[String] = js.undefined, port: UndefOr[Int] = js.undefined, localAddress: UndefOr[String] = js.undefined, socketPath: UndefOr[String] = js.undefined, method: UndefOr[String] = js.undefined, path: UndefOr[String] = js.undefined, headers: UndefOr[Object] = js.undefined, auth: UndefOr[String] = js.undefined, agent: UndefOr[String] = js.undefined, createConnection: UndefOr[Function] = js.undefined)

    protocol

    Protocol to use. Defaults to 'http:'.

    host

    Alias for host. To support url.parse() hostname is preferred over host.

    hostname

    Alias for host. To support url.parse() hostname is preferred over host.

    family

    IP address family to use when resolving host and hostname. Valid values are 4 or 6. When unspecified, both IP v4 and v6 will be used.

    port

    Port of remote server. Defaults to 80.

    localAddress

    Local interface to bind for network connections.

    socketPath

    Unix Domain Socket (use one of host:port or socketPath).

    method

    A string specifying the HTTP request method. Defaults to 'GET'.

    path

    Request path. Defaults to '/'. Should include query string if any. E.G. '/index.html?page=12'. An exception is thrown when the request path contains illegal characters. Currently, only spaces are rejected but that may change in the future.

    headers

    An object containing request headers.

    auth

    Basic authentication i.e. 'user:password' to compute an Authorization header.

    agent

    Controls Agent behavior. When an Agent is used request will default to Connection: keep-alive. Possible values: TODO

    createConnection

    A function that produces a socket/stream to use for the request when the agent option is not used. This can be used to avoid creating a custom Agent class just to override the default createConnection function.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. var agent: UndefOr[String]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. var auth: UndefOr[String]
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. var createConnection: UndefOr[Function]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. var family: UndefOr[String]
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  16. var headers: UndefOr[Object]
  17. var host: UndefOr[String]
  18. var hostname: UndefOr[String]
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  21. var localAddress: UndefOr[String]
  22. var method: UndefOr[String]
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  26. var path: UndefOr[String]
  27. var port: UndefOr[Int]
  28. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  29. var protocol: UndefOr[String]
  30. var socketPath: UndefOr[String]
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toLocaleString(): String
    Definition Classes
    Object
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def valueOf(): Any
    Definition Classes
    Object
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped