cb fetch

buscar cb

Uma biblioteca verdadeiramente compatível com vários navegadores e versões futuras para fazer solicitações HTTP assíncronas que seguem o padrão de retorno de chamada .

Índice

• Uso
  • Instalação
  • Importação
  • Exemplos
• Apoiar
• Métodos
• Propriedades
• Pegadinhas
• Licença

Uso

Instalação

npm

npm install --save cb-fetch

fio

yarn add cb-fetch

jspm

jspm install cb-fetch

caramanchão

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 >

Importação

AMD

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

CJS

compatível com padrão

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

Compatível com 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');
  

Namespace Global

Se nenhum dos métodos de registro de módulo listados anteriormente for suportado, uma variável global chamada request será exposta.

Exemplos

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

Apoiar

• fetch
• XMLHttpRequest
• XDomainRequest
• Definição de Módulo Universal
• WebDAV
• Texto datilografado
• Fluxo

Métodos

obter / cabeça / excluir / postar / corrigir / colocar

 (Options.url?) => Object

consulta

 (Options.parameters?) => Object

enviar

 (Options.body?) => Object

gancho

início de carregamento

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

download

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

extremidade de carga

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

passar

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

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

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

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

feito

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

Propriedades

Opções de solicitação

Propriedade	Padrão	Valor(es)
corpo	nulo	BufferSource, Blob, Document², FormData, String, URLSearchParams, ReadableStream
credenciais	'mesma origem'	'incluir', 'omitir'⁶, 'mesma origem'
cabeçalhos	{}	Objeto, Cabeçalhos³
método	'PEGAR'	Corda
modo	'mesma origem'	'cors', 'no-cors'¹, 'mesma origem'
senha	nulo	Corda
parâmetros		URLSearchParams, Objeto, String
respostaMediaType²		Corda
tipo de resposta		'texto', 'json', 'blob', 'documento', 'arraybuffer', 'formdata'¹, 'moz-blob', 'moz-chunked-arraybuffer', 'moz-chunked-text', 'msxml- documento'
tempo esgotado	0	ℕ
nome de usuário	nulo	Corda
url	localização.href	Sequência, URL
várias partes⁷	falso	Booleano
túnel⁵	falso	Booleano
Padrão XSLP⁴	falso	Booleano

Evento de Progresso

Propriedade	Tipo
pedaço	String, ArrayBuffer, Blob, Uint8Array, nulo
agregar	String, ArrayBuffer, Blob, Uint8Array, nulo
carregado	ℕ
total	ℕ
comprimentoComputável	Booleano

Resposta

Propriedade	Tipo
corpo	Objeto, String, Documento, ArrayBuffer, Blob, FormData¹, ReadableStream¹, nulo
cabeçalhos	Objeto
exemplo	XMLHttpRequest, XDomainRequest, Resposta, AnonXMLHttpRequest
código de status	ℕ
statusText	Corda
url	Corda

_{^{¹ buscar apenas
² Somente XHR
³ exceto Gecko 34–43
⁴ Somente MSXML 3.0
⁵ substituição de método
⁶ buscar, Gecko 16+, Presto/2.10.232–2.12.423
⁷ Lagartixa 1.7β–22}}

Pegadinhas

delete palavra-chave reservada

Em ambientes anteriores ao ES5, o método delete requer o uso da notação de colchetes.

lagartixa

Para que os navegadores desenvolvidos com Gecko 1.9.1–20 tenham os cabeçalhos de resposta expostos preenchidos na propriedade headers , as seguintes condições devem ser atendidas:

• O cabeçalho de resposta Access-Control-Expose-Headers se expõe
• O valor do campo Access-Control-Expose-Headers não é *
• mode definido como cors

Tridente

Limitações intrínsecas XDomainRequest

• suporta apenas métodos GET e POST
• não é possível definir cabeçalhos de solicitação
• sem credenciais
• mesma restrição de esquema
• as classes de código de status informativo e de redirecionamento são consideradas erros
• o código de status e o texto de status da resposta não são fornecidos
• solicitações de mesma origem também exigem que o servidor responda com um cabeçalho Access-Control-Allow-Origin * ou o URL exato do documento solicitante

Plataforma para preferências de privacidade

As configurações padrão do Internet Explorer restringem o uso de cookies de ^terceiros , a menos que uma declaração de política compacta P3P tenha sido incluída por meio de um cabeçalho de resposta HTTP personalizado; portanto, o modo de "include" de credenciais não pode ser totalmente respeitado se um cookie for considerado insatisfatório.

Licença