@blockquote-web-components/ajax-provider 1.3.2 → 1.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -43
- package/package.json +3 -3
- package/src/AjaxProvider.js +4 -4
package/README.md
CHANGED
|
@@ -203,30 +203,30 @@ Requests can be made by passing the relevant config to `AjaxProvider`.
|
|
|
203
203
|
|
|
204
204
|
##### Fields
|
|
205
205
|
|
|
206
|
-
| Name | Privacy | Type | Default
|
|
207
|
-
| ------------------------- | ------- | ------------------- |
|
|
208
|
-
| `dispatchEventContext` | | `Object` | `this`
|
|
209
|
-
| `lastResponse` | | `Object`
|
|
210
|
-
| `lastError` | | `Object`
|
|
211
|
-
| `customEventPrefix` | | `string` | `'ajax'`
|
|
212
|
-
| `avoidBoundary` | | `boolean` | `false`
|
|
213
|
-
| `url` | | `string` | `''`
|
|
214
|
-
| `path` | | `string` | `''`
|
|
215
|
-
| `body` | | `*` | `undefined`
|
|
216
|
-
| `async` | | `boolean` | `true`
|
|
217
|
-
| `method` | | `string` | `'GET'`
|
|
218
|
-
| `_headers` | | `Object` | `{
|
|
219
|
-
| `headers` | | `Object\|undefined` | `undefined`
|
|
220
|
-
| `timeout` | | `number` | `0`
|
|
221
|
-
| `user` | | `string` | `''`
|
|
222
|
-
| `password` | | `string` | `''`
|
|
223
|
-
| `withCredentials` | | `boolean` | `false`
|
|
224
|
-
| `xsrfCookieName` | | `string` | `''`
|
|
225
|
-
| `xsrfHeaderName` | | `string` | `''`
|
|
226
|
-
| `responseType` | | `string` | `''`
|
|
227
|
-
| `queryParams` | | `Object\|undefined` | `undefined`
|
|
228
|
-
| `includeDownloadProgress` | | `boolean` | `false`
|
|
229
|
-
| `includeUploadProgress` | | `boolean` | `false`
|
|
206
|
+
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
207
|
+
| ------------------------- | ------- | ------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
|
|
208
|
+
| `dispatchEventContext` | | `Object` | `this` | The context for dispatching events. | |
|
|
209
|
+
| `lastResponse` | | `Object\|undefined` | `undefined` | The last AJAX response object. | |
|
|
210
|
+
| `lastError` | | `Object\|undefined` | `undefined` | The last error object. | |
|
|
211
|
+
| `customEventPrefix` | | `string` | `'ajax'` | A custom event prefix for events related to HTTP requests. | |
|
|
212
|
+
| `avoidBoundary` | | `boolean` | `false` | Set to \`true\` to stop delegating the use of boundaries for multipart requests to the browser.
Only change this to \`true\` if you know what you are doing. | |
|
|
213
|
+
| `url` | | `string` | `''` | The base URL for the AJAX request. | AjaxProviderMixin |
|
|
214
|
+
| `path` | | `string` | `''` | The path to append to the base URL. | AjaxProviderMixin |
|
|
215
|
+
| `body` | | `*` | `undefined` | The request body. | AjaxProviderMixin |
|
|
216
|
+
| `async` | | `boolean` | `true` | Whether or not to send the request asynchronously. | AjaxProviderMixin |
|
|
217
|
+
| `method` | | `string` | `'GET'` | The HTTP request method (e.g., GET, POST). | AjaxProviderMixin |
|
|
218
|
+
| `_headers` | | `Object` | `{ Accept: 'application/json, text/plain, */*; q=0.01', 'Content-Type': 'application/json', }` | The default headers for the request. | AjaxProviderMixin |
|
|
219
|
+
| `headers` | | `Object\|undefined` | `undefined` | Custom headers for the request. | AjaxProviderMixin |
|
|
220
|
+
| `timeout` | | `number` | `0` | The request timeout in milliseconds. | AjaxProviderMixin |
|
|
221
|
+
| `user` | | `string` | `''` | The user for authentication. | AjaxProviderMixin |
|
|
222
|
+
| `password` | | `string` | `''` | The password for authentication. | AjaxProviderMixin |
|
|
223
|
+
| `withCredentials` | | `boolean` | `false` | Indicates whether to include credentials with the request. | AjaxProviderMixin |
|
|
224
|
+
| `xsrfCookieName` | | `string` | `''` | The name of the XSRF cookie. | AjaxProviderMixin |
|
|
225
|
+
| `xsrfHeaderName` | | `string` | `''` | The name of the XSRF header. | AjaxProviderMixin |
|
|
226
|
+
| `responseType` | | `string` | `''` | The response type (e.g., 'json', 'text'). | AjaxProviderMixin |
|
|
227
|
+
| `queryParams` | | `Object\|undefined` | `undefined` | The query parameters to include in the request URL. | AjaxProviderMixin |
|
|
228
|
+
| `includeDownloadProgress` | | `boolean` | `false` | Indicates whether to include download progress in the response. | AjaxProviderMixin |
|
|
229
|
+
| `includeUploadProgress` | | `boolean` | `false` | Indicates whether to include upload progress in the response. | AjaxProviderMixin |
|
|
230
230
|
|
|
231
231
|
##### Methods
|
|
232
232
|
|
|
@@ -277,25 +277,25 @@ Mixin for providing AJAX functionality using RxJS. This mixin can be used to enh
|
|
|
277
277
|
|
|
278
278
|
##### Fields
|
|
279
279
|
|
|
280
|
-
| Name | Privacy | Type | Default
|
|
281
|
-
| ------------------------- | ------- | ------------------- |
|
|
282
|
-
| `url` | | `string` | `''`
|
|
283
|
-
| `path` | | `string` | `''`
|
|
284
|
-
| `body` | | `*` | `undefined`
|
|
285
|
-
| `async` | | `boolean` | `true`
|
|
286
|
-
| `method` | | `string` | `'GET'`
|
|
287
|
-
| `_headers` | | `Object` | `{
|
|
288
|
-
| `headers` | | `Object\|undefined` | `undefined`
|
|
289
|
-
| `timeout` | | `number` | `0`
|
|
290
|
-
| `user` | | `string` | `''`
|
|
291
|
-
| `password` | | `string` | `''`
|
|
292
|
-
| `withCredentials` | | `boolean` | `false`
|
|
293
|
-
| `xsrfCookieName` | | `string` | `''`
|
|
294
|
-
| `xsrfHeaderName` | | `string` | `''`
|
|
295
|
-
| `responseType` | | `string` | `''`
|
|
296
|
-
| `queryParams` | | `Object\|undefined` | `undefined`
|
|
297
|
-
| `includeDownloadProgress` | | `boolean` | `false`
|
|
298
|
-
| `includeUploadProgress` | | `boolean` | `false`
|
|
280
|
+
| Name | Privacy | Type | Default | Description | Inherited From |
|
|
281
|
+
| ------------------------- | ------- | ------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -------------- |
|
|
282
|
+
| `url` | | `string` | `''` | The base URL for the AJAX request. | |
|
|
283
|
+
| `path` | | `string` | `''` | The path to append to the base URL. | |
|
|
284
|
+
| `body` | | `*` | `undefined` | The request body. | |
|
|
285
|
+
| `async` | | `boolean` | `true` | Whether or not to send the request asynchronously. | |
|
|
286
|
+
| `method` | | `string` | `'GET'` | The HTTP request method (e.g., GET, POST). | |
|
|
287
|
+
| `_headers` | | `Object` | `{ Accept: 'application/json, text/plain, */*; q=0.01', 'Content-Type': 'application/json', }` | The default headers for the request. | |
|
|
288
|
+
| `headers` | | `Object\|undefined` | `undefined` | Custom headers for the request. | |
|
|
289
|
+
| `timeout` | | `number` | `0` | The request timeout in milliseconds. | |
|
|
290
|
+
| `user` | | `string` | `''` | The user for authentication. | |
|
|
291
|
+
| `password` | | `string` | `''` | The password for authentication. | |
|
|
292
|
+
| `withCredentials` | | `boolean` | `false` | Indicates whether to include credentials with the request. | |
|
|
293
|
+
| `xsrfCookieName` | | `string` | `''` | The name of the XSRF cookie. | |
|
|
294
|
+
| `xsrfHeaderName` | | `string` | `''` | The name of the XSRF header. | |
|
|
295
|
+
| `responseType` | | `string` | `''` | The response type (e.g., 'json', 'text'). | |
|
|
296
|
+
| `queryParams` | | `Object\|undefined` | `undefined` | The query parameters to include in the request URL. | |
|
|
297
|
+
| `includeDownloadProgress` | | `boolean` | `false` | Indicates whether to include download progress in the response. | |
|
|
298
|
+
| `includeUploadProgress` | | `boolean` | `false` | Indicates whether to include upload progress in the response. | |
|
|
299
299
|
|
|
300
300
|
##### Methods
|
|
301
301
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blockquote-web-components/ajax-provider",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.4",
|
|
4
4
|
"description": "Webcomponent ajax-provider following open-wc recommendations",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"lit",
|
|
@@ -96,13 +96,13 @@
|
|
|
96
96
|
"rxjs": "^8.0.0-alpha.14"
|
|
97
97
|
},
|
|
98
98
|
"devDependencies": {
|
|
99
|
-
"@alenaksu/json-viewer": "^2.0.1",
|
|
100
99
|
"@blockquote-web-components/blockquote-base-common-dev-dependencies": "^1.9.1",
|
|
100
|
+
"inspector-elements": "0.1.0",
|
|
101
101
|
"lit": "^3.1.1"
|
|
102
102
|
},
|
|
103
103
|
"publishConfig": {
|
|
104
104
|
"access": "public"
|
|
105
105
|
},
|
|
106
106
|
"customElements": "custom-elements.json",
|
|
107
|
-
"gitHead": "
|
|
107
|
+
"gitHead": "e90d76e36a24a2c0308e0f8c3a673ef020ad9532"
|
|
108
108
|
}
|
package/src/AjaxProvider.js
CHANGED
|
@@ -181,8 +181,8 @@ import { AjaxProviderMixin } from './AjaxProviderMixin.js';
|
|
|
181
181
|
*
|
|
182
182
|
* - `path`: The path to append to the base URL. _(string)_
|
|
183
183
|
* - `dispatchEventContext`: The context for dispatching events. _(AjaxProvider instance)_
|
|
184
|
-
* - `lastResponse`: The last AJAX response object. _(Object)_
|
|
185
|
-
* - `lastError`: The last error object. _(Object)_
|
|
184
|
+
* - `lastResponse`: The last AJAX response object. _(Object|undefined)_
|
|
185
|
+
* - `lastError`: The last error object. _(Object|undefined)_
|
|
186
186
|
* - `customEventPrefix`: A custom event prefix for events related to HTTP requests. _(string)_
|
|
187
187
|
* - Default value: `ajax`
|
|
188
188
|
* - `avoidBoundary`: Set to `true` to stop delegating the use of [boundaries for multipart requests to the browser](https://github.com/axios/axios/issues/4631). _(boolean)_
|
|
@@ -209,13 +209,13 @@ export class AjaxProvider extends AjaxProviderMixin(EventTarget) {
|
|
|
209
209
|
|
|
210
210
|
/**
|
|
211
211
|
* The last AJAX response object.
|
|
212
|
-
* @type {Object}
|
|
212
|
+
* @type {Object|undefined}
|
|
213
213
|
*/
|
|
214
214
|
this.lastResponse = undefined;
|
|
215
215
|
|
|
216
216
|
/**
|
|
217
217
|
* The last error object.
|
|
218
|
-
* @type {Object}
|
|
218
|
+
* @type {Object|undefined}
|
|
219
219
|
*/
|
|
220
220
|
this.lastError = undefined;
|
|
221
221
|
|