实现了接口, 因此是一个EventEmitter类型.

例如,我们可以创建与github.com相同的请求如下:

Event: 'response'

返回:

• response 收到的消息 - 表示HTTP响应消息的对象。

事件: "login"

返回:

• authInfo Object

  • isProxy Boolean
  • scheme String
  • host String
  • port Integer
  • realm String
• • username String
  • password String
    当身份验证代理请求用户认证时触发

用户证书会调用 callback方法:

• password String

提供空的凭证将取消请求，并在响应对象上报告一个身份验证错误:

Event: 'finish'

在 request 最终的 chunk 数据后写入 request 后触发

Event: 'abort'

当 request请求被中止时发出。如果request 请求已经关闭， abort中止事件将不会被触发。

Event: 'error'

返回:

• error Error -提供失败信息的错误对象。
  当 net网络模块没有发出网络请求时会触发。 通常情况下，当 request请求对象发出一个 error错误事件时，一个 close关闭事件会随之发生，并且不会提供响应对象。

事件： 'close'

作为HTTP 的 request-response 中的最后一个事件发出。 close事件表明，在request或response 对象中不会发出更多的事件。

Event: 'redirect'

• statusCode Integer
• method String
• redirectUrl String
• responseHeaders Object
  当发出重定，并且模式为 manuals(手动)时触发。调用 将持续重定向

request.chunkedEncoding

一个Boolean类型的值，指定请求是否将使用 HTTP 分块传输编码。 默认值为 false. 该属性是可读写的, 但它只能在第一次写入操作之前设置，因为还没有写入 HTTP 头。 在第一写入后如果设置chunkedEncoding属性将引发错误。

如果 request 的 body 是一个大的数据时，强烈建议使用块编码。因为数据将以小块的方式进行传输, 而不是在 Electron 进程内存中内部缓冲。

request.setHeader(name, value)

• name String - 额外的 HTTP 头名称.
• value Object - 额外的 HTTP 头的值.
  添加一个额外的 HTTP 头。 头名称发出时是大写的. 它只能在第一次写入之前调用。 在第一次写入后调用此方法将引发错误。 如果传递的值不是 String, 则会调用 toString () 方法来获取最终值。

request.getHeader(name)

• name String - 指定一个额外的头名称.
  返回 Object-以前设置的额外标头名称的值。

request.removeHeader(name)

• name String - 指定一个额外的头名称.
  删除以前设置的额外头名称。此方法只能在首次写入之前调用。尝试在第一次写入后调用它会引发错误。

request.write(chunk[, encoding][, callback])

• chunk (String | Buffer) - 请求主体数据的一个块。如果是字符串, 它将使用指定的编码转换Buffer。
• encodingString(可选)-用于将字符串块转换为Buffer对象。默认值为 "utf-8"。
• callback Function (可选)-在写操作结束后调用。
  callback 实质上是为了保持与 Node.js API 的相似性而引入的虚拟函数。 在将 chunk 内容传递到 Chromium 网络层之后, 在下一个 tick 中异步调用。 与 Node.js 实现相反, 不保证 chunk 内容在调用 callback 之前已经被刷新。

向请求正文中添加一个数据块。 第一次写操作可能导致在线路上发出请求头。 在第一次写入操作后, 不允许添加或删除自定义标头。

request.end([chunk][, encoding][, callback])

• chunk (String | Buffer) (可选)
• encoding String (可选)
• callback Function (可选)
  发送请求数据的最后一个块。将不允许后续的写入或结束操作。finish 事件将在结束操作后发出。

request.abort()

取消正在进行的 HTTP 事务。 如果请求已发出 close 事件, 则中止操作将不起作用。 否则正在进行的事件将发出 abort 和 close 事件。 此外, 如果有一个正在进行的响应对象, 它将发出 aborted 事件。

request.followRedirect()

当重定向模式为 manual 手动 时, 将继续延迟的重定向请求。

request.getUploadProgress()

返回 Object:

• active Boolean - Whether the request is currently active. If this is false no other properties will be set
• started Boolean - Whether the upload has started. If this is false both current and total will be set to 0.
• current Integer - The number of bytes that have been uploaded so far
• Integer - The number of bytes that will be uploaded this request
  You can use this method in conjunction with POST requests to get the progress of a file upload or other data transfer.