ObjetHttpRéponse

HttpResponse est un objet de réponse HTTP, utilisantHttpRequest.responseL'objet complète la réponse des données du serveur HTTP, ouhttp.requestDonnées de réponse à la demande renvoyées par le serveur

L'exemple suivant montre commenthttp.ServerUtilisé dans, l'exemple de code est le suivant :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const http = require('http');

const server = new http.Server(8080, (request) => {
// retreive the response object
const response = request.response;
// set the status code
response.statusCode = 200;
// set the content type to text/plain
response.setHeader('Content-Type', 'text/plain');
// write the response body
response.write('ok');
});

server.start();

relation d'héritage

Constructeur

HttpResponse

Constructeur HttpResponse, crée un nouvel objet HttpResponse

1
new HttpResponse();

constante

TEXT

Spécifiez le type de message 1, qui représente un type de texte

1
const HttpResponse.TEXT = 1;

BINARY

Spécifiez le type de message 2, représentant un type binaire

1
const HttpResponse.BINARY = 2;

propriétés des membres

statusCode

Entier, interroger et définir l'état de retour du message de réponse

1Integer HttpResponse.statusCode;

statusMessage

Chaîne, interroge et définit le message de retour du message de réponse

1
String HttpResponse.statusMessage;

status

Entier, interrogez et définissez l'état de retour du message de réponse, équivalent à statusCode

1Integer HttpResponse.status;

ok

Booléen, demande si la réponse actuelle est normale

1
readonly Boolean HttpResponse.ok;

cookies

NArray, renvoie le message actuelHttpCookieliste d'objets

1readonly NArray HttpResponse.cookies;

protocol

Chaîne, informations sur la version du protocole, le format autorisé est : HTTP/#.#

1
String HttpResponse.protocol;

headers

HttpCollection, inclus dans le messagehttpConteneur pour les en-têtes de message, propriété en lecture seule

1readonly HttpCollection HttpResponse.headers;

keepAlive

Booléen, interroge et définit s'il faut maintenir la connexion

1
Boolean HttpResponse.keepAlive;

upgrade

Booléen, interroge et définit s'il s'agit d'un protocole de mise à niveau

1
Boolean HttpResponse.upgrade;

maxHeadersCount

Entier, interrogez et définissez le nombre maximum d'en-têtes de requête, la valeur par défaut est 128

1Integer HttpResponse.maxHeadersCount;

maxHeaderSize

Entier, interrogez et définissez la longueur maximale de l'en-tête de requête, la valeur par défaut est 8192

1Integer HttpResponse.maxHeaderSize;

maxBodySize

Entier, interrogez et définissez la taille maximale du corps en Mo, la valeur par défaut est 64

1Integer HttpResponse.maxBodySize;

socket

Stream, Interroger la socket source de l'objet actuel

1readonly Stream HttpResponse.socket;

value

String, le contenu de base du message

1
String HttpResponse.value;

params

NArray, les paramètres de base du message

1readonly NArray HttpResponse.params;

type

Entier, type de message

1Integer HttpResponse.type;

data

Valeur, interroge les données du message. Cet attribut renverra des données différentes en fonction du type de contenu. Lorsqu'il s'agit de texte, le texte sera renvoyé.jsonrevenir quandjson, sinon il renvoie du binaire

1readonly Value HttpResponse.data;

body

SeekableStream, un objet flux contenant la partie données du message

1SeekableStream HttpResponse.body;

length

Long : la longueur de la partie des données du message

1readonly Long HttpResponse.length;

stream

Stream, l'objet flux lors de l'interrogation du message readFrom

1readonly Stream HttpResponse.stream;

lastError

Chaîne, interroge et définit la dernière erreur de traitement du message

1
String HttpResponse.lastError;

fonction membre

writeHead

Définir l'état de retour du message de réponse, renvoyer le message et ajouter l'en-tête de réponse

1
2
3HttpResponse.writeHead(Integer statusCode,
    String statusMessage,
    Object headers = {});

Paramètres d'appel :

statusCode: Entier, spécifie l'état de retour du message de réponse
statusMessage: String, spécifie le message de retour du message de réponse
headers: Objet, spécifie l'en-tête de réponse ajouté au message de réponse

Définir l'état de retour du message de réponse, renvoyer le message et ajouter l'en-tête de réponse

1
2HttpResponse.writeHead(Integer statusCode,
    Object headers = {});

Paramètres d'appel :

statusCode: Entier, spécifie l'état de retour du message de réponse
headers: Objet, spécifie l'en-tête de réponse ajouté au message de réponse

addCookie

Ajoutez-en un aux cookiesHttpCookieobjet

1HttpResponse.addCookie(HttpCookie cookie);

Paramètres d'appel :

cookie:HttpCookie, spécifie leHttpCookieobjet

redirect

Envoyer la redirection au client

1
HttpResponse.redirect(String url);

Paramètres d'appel :

url: Chaîne, adresse redirigée

Envoyer la redirection au client

1
2HttpResponse.redirect(Integer statusCode,
    String url);

Paramètres d'appel :

statusCode: Entier, précise l'état de retour du message de réponse, l'état accepté est : 301, 302, 307
url: Chaîne, adresse redirigée

sendHeader

Envoyer formaté uniquementhttpDirigez-vous vers l'objet de flux donné

1
HttpResponse.sendHeader(Stream stm) async;

Paramètres d'appel :

stm:Stream, spécifie l'objet de flux qui reçoit le message formaté

hasHeader

Vérifiez s'il existe un en-tête de message avec la valeur de clé spécifiée

1
Boolean HttpResponse.hasHeader(String name);

Paramètres d'appel :

name: String, spécifie la valeur clé à vérifier

Résultats de retour :

Boolean, renvoie si la valeur clé existe

firstHeader

Interroger le premier en-tête de message de la valeur de clé spécifiée

1
String HttpResponse.firstHeader(String name);

Paramètres d'appel :

name: String, spécifiez la valeur clé à interroger

Résultats de retour :

String, renvoie la valeur correspondant à la valeur clé, si elle n'existe pas, renvoie undéfini

allHeader

Interroger tous les en-têtes de message de la valeur de clé spécifiée

1
NObject HttpResponse.allHeader(String name = "");

Paramètres d'appel :

name: String, spécifiez la valeur clé à interroger, transmettez une chaîne vide pour renvoyer les résultats de toutes les valeurs clés

Résultats de retour :

NObject, renvoie un tableau de toutes les valeurs correspondant à la valeur clé. Si les données n'existent pas, renvoie null.

addHeader

Ajoutez un en-tête de message, ajoutez des données et ne modifiez pas l'en-tête de message de la valeur clé existante

1
HttpResponse.addHeader(Object map);

Paramètres d'appel :

map: Objet, spécifie le dictionnaire de données clé-valeur à ajouter

Ajoute un ensemble d'en-têtes avec le nom spécifié. L'ajout de données ne modifie pas les en-têtes des valeurs de clé existantes.

1
2
HttpResponse.addHeader(String name,
    Array values);

Paramètres d'appel :

name: String, spécifie la valeur clé à ajouter
values : Array, spécifie un ensemble de données à ajouter

Ajoutez un en-tête de message, ajoutez des données et ne modifiez pas l'en-tête de message de la valeur clé existante

1
2
HttpResponse.addHeader(String name,
    String value);

Paramètres d'appel :

name: String, spécifie la valeur clé à ajouter
value: String, spécifiez les données à ajouter

setHeader

Définir un en-tête de message. La définition des données modifiera la première valeur correspondant à la valeur clé et effacera les en-têtes de message restants avec la même valeur clé.

1
HttpResponse.setHeader(Object map);

Paramètres d'appel :

map: Objet, spécifie le dictionnaire de données clé-valeur à définir

Définissez un ensemble d'en-têtes de message avec le nom spécifié. La définition des données modifiera la valeur correspondant à la valeur de clé et effacera les en-têtes de message restants avec la même valeur de clé.

1
2
HttpResponse.setHeader(String name,
    Array values);

Paramètres d'appel :

name: String, spécifiez la valeur clé à définir
values : Array, spécifie un ensemble de données à définir

Définir un en-tête de message. La définition des données modifiera la première valeur correspondant à la valeur clé et effacera les en-têtes de message restants avec la même valeur clé.

1
2
HttpResponse.setHeader(String name,
    String value);

Paramètres d'appel :

name: String, spécifiez la valeur clé à définir
value: String, spécifiez les données à définir

removeHeader

Supprimer tous les en-têtes de message avec la valeur de clé spécifiée

1
HttpResponse.removeHeader(String name);

Paramètres d'appel :

name: String, spécifie la valeur clé à supprimer

read

Lit des données de taille spécifiée à partir du flux.Cette méthode est un alias de la méthode correspondante de body.

1
Buffer HttpResponse.read(Integer bytes = -1) async;

Paramètres d'appel :

bytes : Nombre entier, spécifie la quantité de données à lire. La valeur par défaut est de lire des blocs de données de taille aléatoire. La taille des données lues dépend de l'appareil.

Résultats de retour :

Buffer, renvoie les données lues à partir du flux. S'il n'y a aucune donnée à lire ou si la connexion est interrompue, null est renvoyé.

readAll

Lit toutes les données restantes du flux.Cette méthode est un alias de la méthode correspondante de body.

1
Buffer HttpResponse.readAll() async;

Résultats de retour :

Buffer, renvoie les données lues à partir du flux. S'il n'y a aucune donnée à lire ou si la connexion est interrompue, null est renvoyé.

write

Écrivez les données données.Cette méthode est un alias de la méthode correspondante dans le corps.

1
HttpResponse.write(Buffer data) async;

Paramètres d'appel :

data:Buffer, étant donné les données à écrire

json

Écrit les données données en codage JSON

1Value HttpResponse.json(Value data);

Paramètres d'appel :

data: Valeur, compte tenu des données à écrire

Résultats de retour :

Value, cette méthode ne renvoie pas de données

Analyser les données du message sous forme d'encodage JSON

1Value HttpResponse.json();

Résultats de retour :

Value, renvoie le résultat analysé

pack

parmsgpackL'encodage écrit les données données

1Value HttpResponse.pack(Value data);

Paramètres d'appel :

data: Valeur, compte tenu des données à écrire

Résultats de retour :

Value, cette méthode ne renvoie pas de données

parmsgpackEncodage et analyse des données dans le message

1Value HttpResponse.pack();

Résultats de retour :

Value, renvoie le résultat analysé

end

Définir la fin du traitement du message en cours,ChainLe processeur ne poursuit pas les transactions ultérieures

1HttpResponse.end();

isEnded

Demander si le message en cours est terminé

1
Boolean HttpResponse.isEnded();

Résultats de retour :

Boolean, renvoie vrai une fois terminé

clear

Contenu clair du message

1HttpResponse.clear();

sendTo

Envoie un message formaté à l'objet de flux donné

1
HttpResponse.sendTo(Stream stm) async;

Paramètres d'appel :

stm:Stream, spécifie l'objet de flux qui reçoit le message formaté

readFrom

Lit le message formaté à partir de l'objet de flux de cache donné et analyse l'objet renseigné

1
HttpResponse.readFrom(Stream stm) async;

Paramètres d'appel :

stm:Stream, spécifie l'objet de flux pour lire les messages formatés

toString

Renvoie la représentation sous forme de chaîne de l'objet. Généralement, "[Native Object]" est renvoyé. L'objet peut être réimplémenté en fonction de ses propres caractéristiques.

1
String HttpResponse.toString();

Résultats de retour :

String, renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie une représentation au format JSON de l'objet, renvoyant généralement une collection de propriétés lisibles définies par l'objet.

1
Value HttpResponse.toJSON(String key = "");

Paramètres d'appel :

key: Chaîne, non utilisée

Résultats de retour :

Value, renvoie une valeur contenant du JSON sérialisable

Guide de développement

Module de base

objets intégrés

module communautaire

ObjetHttpRéponse

relation d'héritage

Constructeur

HttpResponse

constante

TEXT

BINARY

propriétés des membres

statusCode

statusMessage

status

ok

cookies

protocol

headers

keepAlive

upgrade

maxHeadersCount

maxHeaderSize

maxBodySize

socket

value

params

type

data

body

length

stream

lastError

fonction membre

writeHead

addCookie

redirect

sendHeader

hasHeader

firstHeader

allHeader

addHeader

setHeader

removeHeader

read

readAll

write

json

pack

end

isEnded

clear

sendTo

readFrom

toString

toJSON