contentful-management 8.1.2 → 8.1.3
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 +7 -17
- package/dist/contentful-management.browser.js +1 -1
- package/dist/contentful-management.browser.min.js +1 -1
- package/dist/contentful-management.legacy.js +1 -1
- package/dist/contentful-management.legacy.min.js +1 -1
- package/dist/contentful-management.node.js +1 -1
- package/dist/contentful-management.node.min.js +1 -1
- package/dist/es-modules/contentful-management.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -102,24 +102,12 @@ You can use the es6 import with the library as follow
|
|
|
102
102
|
|
|
103
103
|
```js
|
|
104
104
|
// import createClient directly
|
|
105
|
-
import
|
|
106
|
-
const client = createClient({
|
|
107
|
-
// This is the access token for this space. Normally you get the token in the Contentful web app
|
|
108
|
-
accessToken: 'YOUR_ACCESS_TOKEN',
|
|
109
|
-
})
|
|
110
|
-
//....
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
OR
|
|
114
|
-
|
|
115
|
-
```js
|
|
116
|
-
// import everything from contentful
|
|
117
|
-
import * as contentful from 'contentful-management'
|
|
105
|
+
import contentful from 'contentful-management'
|
|
118
106
|
const client = contentful.createClient({
|
|
119
107
|
// This is the access token for this space. Normally you get the token in the Contentful web app
|
|
120
108
|
accessToken: 'YOUR_ACCESS_TOKEN',
|
|
121
109
|
})
|
|
122
|
-
|
|
110
|
+
//....
|
|
123
111
|
```
|
|
124
112
|
|
|
125
113
|
## Your first request
|
|
@@ -327,7 +315,7 @@ Interceptor called on every response. Takes Axios response object as an arg. Def
|
|
|
327
315
|
|
|
328
316
|
#### apiAdapter (default: `new RestAdapter(configuration)`)
|
|
329
317
|
|
|
330
|
-
An [`Adapter`](https://github.com/contentful/contentful-management.js/blob/2350b47053459694b21b19c71025632fe57815cc/lib/common-types.ts#L493-L495)
|
|
318
|
+
An [`Adapter`](https://github.com/contentful/contentful-management.js/blob/2350b47053459694b21b19c71025632fe57815cc/lib/common-types.ts#L493-L495)
|
|
331
319
|
that can be utilized to issue requests. It defaults to a [`RestAdapter`](https://github.com/contentful/contentful-management.js/blob/b50534c629a8ddc81637170a07bc63477d136cec/lib/adapters/REST/rest-adapter.ts)
|
|
332
320
|
initialized with provided configuration.
|
|
333
321
|
|
|
@@ -337,9 +325,11 @@ initialized with provided configuration.
|
|
|
337
325
|
> information it needs to issue the request (e.g., host or auth headers)
|
|
338
326
|
|
|
339
327
|
#### throttle (default: `0`)
|
|
328
|
+
|
|
340
329
|
Maximum number of requests per second.
|
|
341
|
-
|
|
342
|
-
- `
|
|
330
|
+
|
|
331
|
+
- `1`-`30` (fixed number of limit),
|
|
332
|
+
- `'auto'` (calculated limit based on your plan),
|
|
343
333
|
- `'0%'` - `'100%'` (calculated % limit based on your plan)
|
|
344
334
|
|
|
345
335
|
### Reference documentation
|
|
@@ -10132,7 +10132,7 @@ function createClient(params) {
|
|
|
10132
10132
|
var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
|
10133
10133
|
var sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
|
|
10134
10134
|
var userAgent = Object(contentful_sdk_core__WEBPACK_IMPORTED_MODULE_0__["getUserAgentHeader"])( // @ts-expect-error
|
|
10135
|
-
"".concat(sdkMain, "/").concat("8.1.
|
|
10135
|
+
"".concat(sdkMain, "/").concat("8.1.3"), params.application, params.integration, params.feature);
|
|
10136
10136
|
var adapter = Object(_create_adapter__WEBPACK_IMPORTED_MODULE_1__["createAdapter"])(params); // Parameters<?> and ReturnType<?> only return the types of the last overload
|
|
10137
10137
|
// https://github.com/microsoft/TypeScript/issues/26591
|
|
10138
10138
|
// @ts-expect-error
|