Skip to content

[docsprint] Add documentation for RequestParameters #9573

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.

Sign up for GitHub

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

Merged
danswick merged 3 commits into from
Apr 20, 2020
Merged

[docsprint] Add documentation for RequestParameters #9573

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
766f532
add documentation for RequestParameters
malwoodsantoro Apr 16, 2020
cdf0782
fix trailing spaces
malwoodsantoro Apr 16, 2020
5bb4396
lowercaseify Boolean
danswick Apr 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/util/ajax.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,29 @@ if (typeof Object.freeze == 'function') {
* @typedef {Object} RequestParameters
* @property {string} url The URL to be requested.
* @property {Object} headers The headers to be sent with the request.
* @property {string} method Request method `'GET' | 'POST' | 'PUT'`.
* @property {string} body Request body.
* @property {string} type Response body type to be returned `'string' | 'json' | 'arrayBuffer'`.
* @property {string} credentials `'same-origin'|'include'` Use 'include' to send cookies with cross-origin requests.
* @property {boolean} collectResourceTiming If true, Resource Timing API information will be collected for these transformed requests and returned in a resourceTiming property of relevant data events.
* @example
* // transformRequest used to modify requests that begin with `http://myHost`
* transformRequest: (url, resourceType)=> {
* if(resourceType === 'Source' && url.startsWith('http://myHost')) {
* return {
* url: url.replace('http', 'https'),
* headers: { 'my-custom-header': true},
* credentials: 'include' // Include cookies for cross-origin requests
* }
* }
* }
* // Example of `RequestParameters` object returned from the above transformRequest function.
* {
* url: 'https://myHost//assets/sample.geojson'
* headers: {'my-custom-header': true}
* credentials: 'include'
* }
*
*/
export type RequestParameters = {
url: string,
Expand Down