Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Progress events without breaking pub-sub #60

Merged
merged 13 commits into from
Nov 13, 2020
Prev Previous commit
Next Next commit
chore: merge upstream/master
  • Loading branch information
Gozala committed Nov 13, 2020
commit 78da3c539ec21fe2217672fe942c284c519f0b83
28 changes: 14 additions & 14 deletions src/http.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,20 @@ const defaults = {

/**
* @typedef {Object} APIOptions - creates a new type named 'SpecialType'
* @prop {any} [body] - Request body
* @prop {Object} [json] - JSON shortcut
* @prop {string} [method] - GET, POST, PUT, DELETE, etc.
* @prop {string} [base] - The base URL to use in case url is a relative URL
* @prop {Headers|Record<string, string>} [headers] - Request header.
* @prop {number} [timeout] - Amount of time until request should timeout in ms.
* @prop {AbortSignal} [signal] - Signal to abort the request.
* @prop {URLSearchParams|Object} [searchParams] - URL search param.
* @prop {string} [credentials]
* @prop {boolean} [throwHttpErrors]
* @prop {function(URLSearchParams): URLSearchParams } [transformSearchParams]
* @prop {function(any): any} [transform] - When iterating the response body, transform each chunk with this function.
* @prop {function(Response): Promise<void>} [handleError] - Handle errors
* @prop {function({total:number, loaded:number, lengthComputable:boolean}):void} [onUploadProgress] - Can be passed to track upload progress.
* @property {any} [body] - Request body
* @property {Object} [json] - JSON shortcut
* @property {string} [method] - GET, POST, PUT, DELETE, etc.
* @property {string} [base] - The base URL to use in case url is a relative URL
* @property {Headers|Record<string, string>} [headers] - Request header.
* @property {number} [timeout] - Amount of time until request should timeout in ms.
* @property {AbortSignal} [signal] - Signal to abort the request.
* @property {URLSearchParams|Object} [searchParams] - URL search param.
* @property {string} [credentials]
* @property {boolean} [throwHttpErrors]
* @property {function(URLSearchParams): URLSearchParams } [transformSearchParams]
* @property {function(any): any} [transform] - When iterating the response body, transform each chunk with this function.
* @property {function(Response): Promise<void>} [handleError] - Handle errors
* @property {function({total:number, loaded:number, lengthComputable:boolean}):void} [onUploadProgress] - Can be passed to track upload progress.
* Note that if this option in passed underlying request will be performed using `XMLHttpRequest` and response will not be streamed.
*/

Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.