Saltar al contenido principal

Clase: ClientRequest

Clase: ClientRequest

Hace solicitudes HTTP/HTTPS.

Proceso: Main
Esta clase no está exportada desde el módulo 'electron'. Sólo está disponible como un valor de retorno de otros métodos en la API de Electron.

Peticiones del cliente implementa la interfaz de corriente de escritura y por lo tanto es un emitidor de eventos.

new ClientRequest(options)

  • options (Object | String) - Si options es un String, es interpretado como la URL de la solicitud. Si es un objeto, se espera que especifique completamente una solicitud HTTP a través de las siguientes propiedades:
    • method String (opcional) - El método de la solicitud HTTP. Por defecto es el método GET.
    • url String (opcional) - La URL de la solicitud. Debe ser proporcionada de forma absoluta con el esquema del protocolo especificado como http o https.
    • session Session (opcional) - La instancia de Session con la cual la solicitud esta asociada.
    • partición Cadena (opcional) - el nombre de la partición en la cual está asociada la solicitud. Por defecto es la cadena vacía. The session option supersedes partition. De esta manera si una sesión está explícitamente especificada, partición es ignorada.
    • credentials String (opcional) - Puede ser include o omit. Whether to send credentials with this request. If set to include, credentials from the session associated with the request will be used. If set to omit, credentials will not be sent with the request (and the 'login' event will not be triggered in the event of a 401). This matches the behavior of the fetch option of the same name. If this option is not specified, authentication data from the session will be sent, and cookies will not be sent (unless useSessionCookies is set).
    • useSessionCookies Boolean (opcional) - Si enviar cookies con esta solicitud desde la sesión poporcionada. If credentials is specified, this option has no effect. Por defecto es false.
    • protocol String (opcional) - Puede ser http: o https:. The protocol scheme in the form 'scheme:'. Por defecto 'http:'.
    • host Cadena (opcional) - El servidor central proporcionado como una concatenación de nombres de anfitrión y el número de puerto "nombre del host:puerto".
    • nombre de anfitrión Cadena (opcional) - el nombre del servidor central.
    • Puerto Entero (opcional) - el número de puerto listado en el servidor.
    • ruta Cadena (opcional) - La parte de la ruta de la solicitud URL.
    • redirect String (optional) - Can be follow, error or manual. The redirect mode for this request. When mode is error, any redirection will be aborted. When mode is manual the redirection will be cancelled unless request.followRedirect is invoked synchronously during the redirect event. Por defecto es seguir.
    • origin String (optional) - The origin URL of the request.

opcions propiedades como protocolo, central, nombre de anfitrión, puerto y ruta siguen estrictamente al modo Node.js como es descrito en el módulo URL.

Por ejemplo, podemos haber creado la misma solicitud a 'github.com' como sigue:

const request = net.request({
method: 'GET',
protocol: 'https:',
hostname: 'github.com',
port: 443,
path: '/'
})

Eventos de Instancia

Evento: 'response'

Devuelve:

  • response IncomingMessage - An object representing the HTTP response message.

Evento:'login'

Devuelve:

  • authInfo Object
    • isProxy Boolean
    • scheme String
    • anfitrión Cadena
    • puerto Íntegro
    • realm Cadena
  • callback Función
    • username String (opcional)
    • password String (opcional)

Emitido cuando un proxy de autenticación requiere las credenciales del usuario.

Se espera que la función retrollamada sea llamada de vuelta con las credenciales del usuario:

  • username String
  • password String
request.on('login', (authInfo, callback) => {
callback('username', 'password')
})

Proporcional credenciales vacías cancelará la solicitud y reportará un error de autenticación en el objeto de respuesta:

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 justo antes de que el último paquete de los datos de la solicitud haya sido escrito en el objeto solicitud.

Evento: "abort"

Emitido cuando la request es abortada. El evento abort no será lanzado si la request ya está cerrada.

Evento: "error"

Devuelve:

  • error Error - un objeto error proporciona cierta información sobre la falla.

Emitido cuando el módulo net falla en emitir una solicitud de red. Típicamente cuando el objeto solicitud emite un evento error, un evento cerrar lo seguirá subsecuentemente y ningún objeto respuesta será proporcionado.

Evento: "close"

Emitido cuando el último evento en la transacción solicitud-respuesta HTTP. El evento cerrar indica que ningún otro evento será emitido en los objetos solicitud o respuesta.

Evento: "redirect"

Devuelve:

  • Estatus de código entero
  • method String
  • Redirigir Url Cadena
  • responseHeaders Record<String, String[]>

Emitido cuando el servidor devuelve una respuesta redirect (por ejemplo 301 Moved Permanently). Llamar a request.followRedirect continuará con la redirección. Si este evento es manejado, request.followRedirect debe ser llamado synchronously, de otra manera la solicitud será cancelada.

Propiedades de la instancia

request.chunkedEncoding

Un Booleano especificando cuando la solicitud usará el la codificación de transferencia del paquete HTTP o no. Por defecto es falso. La propiedad es de lectura y escritura, sin embargo puede ser configurada antes de la primera operación de escritura debido a que el encabezado HTTP no se ha puesto en el hilo. Tratar de configurar la propiedad codificación empaquetada después de la primera escritura arrojará un error.

Utilizar codificación empaquetada es fuertemente recomendado si no necesita enviar una solicitud grande dado que lo datos serán transmitidos en paquetes pequeños en lugar de ser cargados internamente en la memoria de proceso de Electron.

Métodos de Instancia

request.setHeader(name, value)

  • nombre Cadena - Un nombre de encabezado HTTP extra.
  • value String - Un valor de cabecera HTTP extra.

Añade otro encabezado HTTP. El nombre de la cabecera se emitirá tal cual sin convertirlas a minúscula. Será llamado solo antes de la primera escritura. Llamar a este método despues de la primera escritura arrojará un error. Si el valor pasado no es una Cadena, llamará a su método toString() para obtener el valor final.

Ciertos encabezados están restringidos de ser definidos por aplicaciones. Estos encabezados se enlistan a continuación. Más información sobre encabezados restringidos puede ser encontrada en Chromium's header utils.

  • Content-Length
  • Host
  • Trailer or Te
  • Upgrade
  • Cookie2
  • Keep-Alive
  • Transfer-Encoding

Además, definir el encabezado Connection al valor upgrade también está dehabilitado.

request.getHeader(name)

  • nombre Cadena - Especifica el nombre del encabezado extra.

Devuelve String - El valor de un nombre de cabecera extra establecido anteriormente.

request.removeHeader(name)

  • nombre Cadena - Especifica el nombre del encabezado extra.

Elimina un nombre de cabecera establecido previamente. 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.
  • encoding String (optional) - Used to convert string chunks into Buffer objects. Defaults to 'utf-8'.
  • retrollamada función (opcional) - Llamado cuando se haya realizado la operación de escritura.

La retrollamada es esencialmente una función sencilla introducida con el propósito de mantener similitudes con el API Node.js. Es llamada asincrónicamente en el siguiente tick después de que el contenido del paquete haya sido entregado a la capa de red de Chromium. A diferencia de la implementación de Node.js, no está garantizado que el contenido del paquete haya sido entregado en el hilo antes de que sea llamada retrollamada.

Agrega un paquete de datos al cuerpo de la solicitud. La primera operación de escritura pudiese causar que el encabezado de la solicitud sea cambiado en el hilo. Después de la primera operación de escritura, no está permitido el añadir o remover un encabezado personalizado.

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

  • paquete (Cadena | Almacenamiento) (opcional)
  • codificación Cadena (opcional)
  • retrocallback Funcion (opcional)

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()

Cancela una transacción HTTP en proceso. Si la solicitud ya emitió el evento de cerrar, la operación abortar no tendrá ningún efecto. De otra manera un evento en proceso emitirá los eventos abortar y cerrar. Adicionalmente, si hay algún objeto de respuesta activo, será emitido el evento abortado.

request.followRedirect()

Continues any pending redirection. Can only be called during a 'redirect' event.

request.getUploadProgress()

Devuelve Objeto:

  • 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 - El número de bytes que se han subido hasta ahora
  • total Integer - El número de bytes que ha subido esta solicitud

Puedes usar este método en conjunto con solicitudes POST para obtener el progreso de la carga de un archivo u otro dato de transferencia.