Class: ClientRequest
Class: ClientRequest
Realiza requisições HTTP/HTTPS.
Process: Main, Utility
This class is not exported from the 'electron' module. Ele é somente disponibilizado como um valor de retorno de outros métodos na API Electron.
ClientRequest implementa a interface Writable Stream e deste modo um EventEmitter.
new ClientRequest(opções)
As propriedades em options, como protocol, host, hostname, port e path seguem estritamente o modelo Node.js, como descrito no módulo URL.
Por exemplo, nós poderíamos criar a mesma requisição para 'github.com' da seguinte forma:
const request = net.request({
method: 'GET',
protocol: 'https:',
hostname: 'github.com',
port: 443,
path: '/'
})
Eventos de instância
Evento: 'response'
Retorna:
responseIncomingMessage - An object representing the HTTP response message.
Evento: 'login'
Retorna:
- Objeto
authInfoisProxybooleanschemestringhoststringportIntegerrealmstring
callbackFunctionusernamestring (optional)passwordstring (optional)
Emitido quando um proxy de autenticação está solicitando as credenciais de usuário.
A função de callback é esperada para chamar de volta as credenciais do usuário:
usernamestringpasswordstring
request.on('login', (authInfo, callback) => {
callback('username', 'password')
})
Informar credenciais vazias irá cancelar a requisição e reportar um erro de autenticação no objeto de resposta:
request.on('response', (response) => {
console.log(`STATUS: ${response.statusCode}`)
response.on('error', (error) => {
console.log(`ERROR: ${JSON.stringify(error)}`)
})
})
request.on('login', (authInfo, callback) => {
callback()
})
Evento: 'finish'
Emitido logo após o último pedaço dos dados de request for escrito no objeto request.
Evento: 'abort'
Emitted when the request is aborted. The abort event will not be fired if the request is already closed.
Evento: 'error'
Retorna:
errorError - um objeto de erro que provê informações sobre a falha.
Emitido quando o módulo net falha ao emitir uma requisição de rede. Normalmente quando o objeto request emite um evento error, um evento close virá a seguir e nenhum objeto de resposta será fornecido.
Evento: 'close'
Emitido como último evento na transação HTTP de requisição-resposta. O evento close indica que nenhum outro evento será emitido no objeto request e nem no objeto response.
Evento: 'redirect'
Retorna:
statusCodeIntegermethodstringredirectUrlstringresponseHeadersRecord<string, string[]>
Emitted when the server returns a redirect response (e.g. 301 Moved Permanently). Calling request.followRedirect will continue with the redirection. If this event is handled, request.followRedirect must be called synchronously, otherwise the request will be cancelled.
Propriedades da Instância
request.chunkedEncoding
A boolean specifying whether the request will use HTTP chunked transfer encoding or not. Defaults to false. The property is readable and writable, however it can be set only before the first write operation as the HTTP headers are not yet put on the wire. Trying to set the chunkedEncoding property after the first write will throw an error.
Using chunked encoding is strongly recommended if you need to send a large request body as data will be streamed in small chunks instead of being internally buffered inside Electron process memory.
Métodos de Instância
request.setHeader(name, value)
namestring - An extra HTTP header name.valuestring - An extra HTTP header value.
Adds an extra HTTP header. The header name will be issued as-is without lowercasing. It can be called only before first write. Calling this method after the first write will throw an error. If the passed value is not a string, its toString() method will be called to obtain the final value.
Certain headers are restricted from being set by apps. These headers are listed below. More information on restricted headers can be found in Chromium's header utils.
Content-LengthHostTrailerouTeFazer upgradeCookie2Keep-AliveTransfer-Encoding
Additionally, setting the Connection header to the value upgrade is also disallowed.
request.getHeader(name)
namestring - Specify an extra header name.
Returns string - The value of a previously set extra header name.
request.removeHeader(name)
namestring - Specify an extra header name.
Removes a previously set extra header name. This method can be called only before first write. Trying to call it after the first write will throw an error.
request.write(chunk[, encoding][, callback])
chunk(string | Buffer) - A chunk of the request body's data. If it is a string, it is converted into a Buffer using the specified encoding.encodingstring (optional) - Used to convert string chunks into Buffer objects. Defaults to 'utf-8'.callbackFunction (optional) - Called after the write operation ends.
callback is essentially a dummy function introduced in the purpose of keeping similarity with the Node.js API. It is called asynchronously in the next tick after chunk content have been delivered to the Chromium networking layer. Contrary to the Node.js implementation, it is not guaranteed that chunk content have been flushed on the wire before callback is called.
Adds a chunk of data to the request body. The first write operation may cause the request headers to be issued on the wire. After the first write operation, it is not allowed to add or remove a custom header.
request.end([chunk][, encoding][, callback])
chunk(string | Buffer) (optional)encodingstring (opcional)callbackFunction (optional)
Retorna this.
Sends the last chunk of the request data. Subsequent write or end operations will not be allowed. The finish event is emitted just after the end operation.
request.abort()
Cancels an ongoing HTTP transaction. If the request has already emitted the close event, the abort operation will have no effect. Otherwise an ongoing event will emit abort and close events. Additionally, if there is an ongoing response object,it will emit the aborted event.
request.followRedirect()
Continues any pending redirection. Can only be called during a 'redirect' event.
request.getUploadProgress()
Retorna Object:
activeboolean - Whether the request is currently active. If this is false no other properties will be setstartedboolean - Whether the upload has started. If this is false bothcurrentandtotalwill be set to 0.currentInteger - The number of bytes that have been uploaded so fartotalInteger - 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.