cb fetch

cb-fetch

Una biblioteca verdaderamente compatible con navegadores y versiones posteriores para realizar solicitudes HTTP asincrónicas que siguen el patrón de devolución de llamada .

Tabla de contenido

• Uso
  • Instalación
  • Importación
  • Ejemplos
• Apoyo
• Métodos
• Propiedades
• Problemas
• Licencia

Uso

Instalación

npm

npm install --save cb-fetch

hilo

yarn add cb-fetch

jspm

jspm install cb-fetch

cenador

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 >

Importación

AMD

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

CJS

Cumple con el estándar

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

Compatible con 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');
  

Espacio de nombres global

Si ninguno de los métodos de registro de módulos enumerados anteriormente es compatible, se expondrá una variable global denominada request .

Ejemplos

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

Apoyo

• fetch
• XMLHttpRequest
• XDomainRequest
• Definición de módulo universal
• WebDAV
• Mecanografiado
• Fluir

Métodos

obtener / encabezado / eliminar / publicar / parchear / poner

 (Options.url?) => Object

consulta

 (Options.parameters?) => Object

enviar

 (Options.body?) => Object

gancho

inicio de carga

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

descargar

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

final de carga

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

aprobar

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

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

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

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

hecho

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

Propiedades

Opciones de solicitud

Propiedad	Por defecto	Valores)
cuerpo	nulo	BufferSource, Blob, Document², FormData, String, URLSearchParams, ReadableStream
cartas credenciales	'mismo origen'	'incluir', 'omitir'⁶, 'mismo origen'
encabezados	{}	Objeto, encabezados³
método	'CONSEGUIR'	Cadena
modo	'mismo origen'	'cors', 'no-cors'¹, 'mismo origen'
contraseña	nulo	Cadena
parámetros		URLSearchParams, objeto, cadena
respuestaMediaType²		Cadena
tipo de respuesta		'text', 'json', 'blob', 'document', 'arraybuffer', 'formdata'¹, 'moz-blob', 'moz-chunked-arraybuffer', 'moz-chunked-text', 'msxml- documento'
se acabó el tiempo	0	ℕ
nombre de usuario	nulo	Cadena
URL	ubicación.href	Cadena, URL
multiparte⁷	FALSO	Booleano
túnel⁵	FALSO	Booleano
XSLPatrón⁴	FALSO	Booleano

Evento de progreso

Propiedad	Tipo
pedazo	Cadena, ArrayBuffer, Blob, Uint8Array, nulo
agregar	Cadena, ArrayBuffer, Blob, Uint8Array, nulo
cargado	ℕ
total	ℕ
longitudComputable	Booleano

Respuesta

Propiedad	Tipo
cuerpo	Objeto, Cadena, Documento, ArrayBuffer, Blob, FormData¹, ReadableStream¹, nulo
encabezados	Objeto
instancia	XMLHttpRequest, XDomainRequest, Respuesta, AnonXMLHttpRequest
código de estado	ℕ
estadoTexto	Cadena
URL	Cadena

_{^{¹ buscar solo
² Solo XHR
³ excepto Gecko 34–43
⁴ Solo MSXML 3.0
⁵ anulación de método
⁶ buscar, Gecko 16+, Presto/2.10.232–2.12.423
⁷ Geco 1.7β–22}}

Problemas

delete palabra clave reservada

En entornos anteriores a ES5, el método de eliminación requiere el uso de la notación entre corchetes.

Geco

Para que los navegadores con tecnología Gecko 1.9.1–20 tengan los encabezados de respuesta expuestos en la propiedad headers , se deben cumplir las siguientes condiciones:

• El encabezado de respuesta Access-Control-Expose-Headers se expone
• El valor del campo Access-Control-Expose-Headers no es *
• mode establecido en cors

Tridente

Limitaciones intrínsecas XDomainRequest

• sólo admite métodos GET y POST
• no se pueden establecer encabezados de solicitud
• sin credenciales
• misma restricción del esquema
• las clases de código de estado informativo y de redireccionamiento se consideran errores
• El código de estado de la respuesta y el texto de estado no se proporcionan.
• Las solicitudes del mismo origen también requieren que el servidor responda con un encabezado Access-Control-Allow-Origin de * o la URL exacta del documento solicitante.

Plataforma para preferencias de privacidad

La configuración predeterminada de Internet Explorer restringe el uso de cookies de ^terceros a menos que se haya incluido una declaración de política compacta P3P a través de un encabezado de respuesta HTTP personalizado; por lo tanto, el modo de "include" credenciales no se puede respetar plenamente si una cookie se considera insatisfactoria.

Licencia