cb fetch

CB-récupérer

Une véritable bibliothèque multi- navigateurs et rétrocompatible pour effectuer des requêtes HTTP asynchrones qui suivent le modèle de rappel .

Table des matières

• Usage
  • Installation
  • Importation
  • Exemples
• Soutien
• Méthodes
• Propriétés
• Des pièges
• Licence

Usage

Installation

npm

npm install --save cb-fetch

fil

yarn add cb-fetch

jspm

jspm install cb-fetch

tonnelle

bower install --save cb-fetch

jsDelivr

< script src = " //cdn.jsdelivr.net/combine/npm/@string/isstring/isString.min.js,npm/cb-fetch/index.min.js " type = " text/javascript " ></ script >

Importation

DMLA

  define(function (require) {
    var request = require('cb-fetch');
  });
  

CJS

conforme aux normes

  var request = require('cb-fetch')['default'];
  

Compatible Node.js

  var request = require('cb-fetch');
  

YUI

  YUI({
    modules: { 'is-string': 'path/to/@string/isstring.js' }
  }).use('is-string', 'cb-fetch', function (Y) {
    var request = Y['default'];
  });
  

TS

  import request = require('cb-fetch');
  

Espace de noms global

Si aucune des méthodes d'enregistrement de module répertoriées précédemment n'est prise en charge, une variable globale nommée request sera exposée.

Exemples

 // here's your typical request
request ( 'http://www.example.com?key1=value1&key2=value2' )
  . done ( response => { /* … */ } ) ;

// taking a comprehensive approach is encouraged though
request ( )
  . get ( 'http://www.example.com' )
  . query ( 'key1=value1&key2=value2' )
  . done ( onSuccessCallback , onErrorCallback ) ;

// passing an object offers options not available otherwise
let abort = request ( {
  url :          new URL ( 'http://www.example.com' ) ,
  parameters :   new URLSearchParams ( '_csrf=TOKEN' ) ,
  mode :         'cors' ,
  credentials :  'include' ,
  responseType : 'json'
} ) . get ( '/segment' )
  . query ( { foo : [ 'bar' , 'qux' ] } )
  . pass ( 'Content-Type' , 'application/json' )
  . hook ( 'download' , e => { /* … */ } )
  . done ( {
    success : onSuccessCallback ,
    error :   onErrorCallback ,
    abort :   onAbortCallback
  } ) ;

// forcefully aborts the request
abort ( ) ; 

Soutien

• fetch
• XMLHttpRequest
• XDomainRequest
• Définition du module universel
• WebDAV
• Manuscrit
• Couler

Méthodes

obtenir/head/supprimer/poster/patch/put

 (Options.url?) => Object

requête

 (Options.parameters?) => Object

envoyer

 (Options.body?) => Object

crochet

démarrage du chargement

 ('loadstart', () => Boolean | Void) => Object

télécharger

 ('download', Object => Any) => Object

fin de chargement

 ('loadend', () => Any) => Object

passer

 {
  (name: String, value: String),
  (headers: Object | Headers)
} => Object

  // assigns
  . pass ( new Headers ( { key : 'value' } ) )

  // appends
  . pass ( { key : 'value' } )

  // sets
  . pass ( 'key' , 'value' )

fait

 {
  (onSuccess?: Function, onError?: Function),
  ({
    success?:  Function,
    error?:    Function,
    timeout?:  Function,
    abort?:    Function
  })
} => () => Void,
  throws: TypeError

Propriétés

Options de demande

Propriété	Défaut	Valeurs)
corps	nul	BufferSource, Blob, Document², FormData, String, URLSearchParams, ReadableStream
informations d'identification	'même origine'	'inclure', 'omettre'⁶, 'même origine'
en-têtes	{}	Objet, en-têtes³
méthode	'OBTENIR'	Chaîne
mode	"même origine"	'cors', 'no-cors'¹, 'même origine'
mot de passe	nul	Chaîne
paramètres		URLSearchParams, objet, chaîne
réponseMediaType²		Chaîne
Type de réponse		'text', 'json', 'blob', 'document', 'arraybuffer', 'formdata'¹, 'moz-blob', 'moz-chunked-arraybuffer', 'moz-chunked-text', 'msxml- document'
temps mort	0	ℕ
nom d'utilisateur	nul	Chaîne
URL	emplacement.href	Chaîne, URL
en plusieurs parties⁷	FAUX	Booléen
tunnelage⁵	FAUX	Booléen
Modèle XSL⁴	FAUX	Booléen

Événement de progression

Propriété	Taper
gros morceau	Chaîne, ArrayBuffer, Blob, Uint8Array, null
agrégat	Chaîne, ArrayBuffer, Blob, Uint8Array, null
chargé	ℕ
total	ℕ
longueurCalculable	Booléen

Réponse

Propriété	Taper
corps	Objet, chaîne, document, ArrayBuffer, Blob, FormData¹, ReadableStream¹, null
en-têtes	Objet
exemple	XMLHttpRequest, XDomainRequest, Réponse, AnonXMLHttpRequest
code d'état	ℕ
texte d'état	Chaîne
URL	Chaîne

_{^{¹ récupérer uniquement
² XHR uniquement
³ sauf Gecko 34-43
⁴ MSXML 3.0 uniquement
⁵ remplacement de méthode
⁶ récupérer, Gecko 16+, Presto/2.10.232–2.12.423
⁷ Gecko 1.7β–22}}

Des pièges

delete le mot clé réservé

Dans les environnements antérieurs à ES5, la méthode delete nécessite l'utilisation de la notation entre crochets.

Gecko

Pour que les navigateurs alimentés par Gecko 1.9.1–20 aient les en-têtes de réponse exposés renseignés dans la propriété headers , les conditions suivantes doivent être remplies :

• L’en-tête de réponse Access-Control-Expose-Headers s’expose
• La valeur du champ Access-Control-Expose-Headers n’est pas *
• mode réglé sur cors

Trident

Limitations intrinsèques XDomainRequest

• ne prend en charge que les méthodes GET et POST
• impossible de définir les en-têtes de requête
• pas d'informations d'identification
• même restriction du régime
• les classes de codes d'état informatif et de redirection sont considérées comme des erreurs
• le code d'état et le texte d'état de la réponse ne sont pas fournis
• les requêtes de même origine nécessitent également que le serveur réponde avec un en-tête Access-Control-Allow-Origin de * ou l'URL exacte du document demandeur

Plateforme pour les préférences de confidentialité

Les paramètres par défaut d'Internet Explorer limitent l'utilisation de cookies ^tiers , sauf si une déclaration de politique compacte P3P a été incluse via un en-tête de réponse HTTP personnalisé ; par conséquent, le mode d'identification "include" ​​ne peut pas être entièrement honoré si un cookie a été jugé insatisfaisant.

Licence