@aws-sdk/client-codeartifact 3.1008.0 → 3.1009.0
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 +26 -46
- package/package.json +34 -34
package/README.md
CHANGED
|
@@ -352,8 +352,9 @@ that specifies permissions to access it. </p>
|
|
|
352
352
|
</ul>
|
|
353
353
|
|
|
354
354
|
## Installing
|
|
355
|
-
|
|
356
|
-
|
|
355
|
+
|
|
356
|
+
To install this package, use the CLI of your favorite package manager:
|
|
357
|
+
|
|
357
358
|
- `npm install @aws-sdk/client-codeartifact`
|
|
358
359
|
- `yarn add @aws-sdk/client-codeartifact`
|
|
359
360
|
- `pnpm add @aws-sdk/client-codeartifact`
|
|
@@ -378,15 +379,15 @@ import { CodeartifactClient, ListDomainsCommand } from "@aws-sdk/client-codearti
|
|
|
378
379
|
|
|
379
380
|
### Usage
|
|
380
381
|
|
|
381
|
-
To send a request
|
|
382
|
+
To send a request:
|
|
382
383
|
|
|
383
|
-
-
|
|
384
|
-
-
|
|
385
|
-
-
|
|
386
|
-
-
|
|
384
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
385
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
386
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
387
|
+
- Instantiate a command with input parameters.
|
|
388
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
387
389
|
|
|
388
390
|
```js
|
|
389
|
-
// a client can be shared by different commands.
|
|
390
391
|
const client = new CodeartifactClient({ region: "REGION" });
|
|
391
392
|
|
|
392
393
|
const params = { /** input parameters */ };
|
|
@@ -395,7 +396,7 @@ const command = new ListDomainsCommand(params);
|
|
|
395
396
|
|
|
396
397
|
#### Async/await
|
|
397
398
|
|
|
398
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
399
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
399
400
|
operator to wait for the promise returned by send operation as follows:
|
|
400
401
|
|
|
401
402
|
```js
|
|
@@ -410,26 +411,9 @@ try {
|
|
|
410
411
|
}
|
|
411
412
|
```
|
|
412
413
|
|
|
413
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
414
|
-
as compared to using Promise chains or callbacks.
|
|
415
|
-
|
|
416
414
|
#### Promises
|
|
417
415
|
|
|
418
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
419
|
-
to execute send operation.
|
|
420
|
-
|
|
421
|
-
```js
|
|
422
|
-
client.send(command).then(
|
|
423
|
-
(data) => {
|
|
424
|
-
// process data.
|
|
425
|
-
},
|
|
426
|
-
(error) => {
|
|
427
|
-
// error handling.
|
|
428
|
-
}
|
|
429
|
-
);
|
|
430
|
-
```
|
|
431
|
-
|
|
432
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
416
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
433
417
|
|
|
434
418
|
```js
|
|
435
419
|
client
|
|
@@ -445,27 +429,21 @@ client
|
|
|
445
429
|
});
|
|
446
430
|
```
|
|
447
431
|
|
|
448
|
-
####
|
|
449
|
-
|
|
450
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
451
|
-
but they are supported by the send operation.
|
|
432
|
+
#### Aggregated client
|
|
452
433
|
|
|
453
|
-
|
|
454
|
-
// callbacks.
|
|
455
|
-
client.send(command, (err, data) => {
|
|
456
|
-
// process err and data.
|
|
457
|
-
});
|
|
458
|
-
```
|
|
434
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
459
435
|
|
|
460
|
-
|
|
436
|
+
`Codeartifact` extends `CodeartifactClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
437
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
461
438
|
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
439
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeartifactClient`).
|
|
440
|
+
More details are in the blog post on
|
|
441
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
465
442
|
|
|
466
443
|
```ts
|
|
467
|
-
import
|
|
468
|
-
|
|
444
|
+
import { Codeartifact } from "@aws-sdk/client-codeartifact";
|
|
445
|
+
|
|
446
|
+
const client = new Codeartifact({ region: "REGION" });
|
|
469
447
|
|
|
470
448
|
// async/await.
|
|
471
449
|
try {
|
|
@@ -485,7 +463,7 @@ client
|
|
|
485
463
|
// error handling.
|
|
486
464
|
});
|
|
487
465
|
|
|
488
|
-
// callbacks.
|
|
466
|
+
// callbacks (not recommended).
|
|
489
467
|
client.listDomains(params, (err, data) => {
|
|
490
468
|
// process err and data.
|
|
491
469
|
});
|
|
@@ -513,12 +491,14 @@ try {
|
|
|
513
491
|
}
|
|
514
492
|
```
|
|
515
493
|
|
|
494
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
495
|
+
|
|
516
496
|
## Getting Help
|
|
517
497
|
|
|
518
498
|
Please use these community resources for getting help.
|
|
519
|
-
We use
|
|
499
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
520
500
|
|
|
521
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
501
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
522
502
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
523
503
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
524
504
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-codeartifact",
|
|
3
3
|
"description": "AWS SDK for JavaScript Codeartifact Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.1009.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-codeartifact",
|
|
@@ -21,42 +21,42 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
24
|
-
"@aws-sdk/core": "^3.973.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
27
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
31
|
-
"@aws-sdk/types": "^3.973.
|
|
32
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
35
|
-
"@smithy/config-resolver": "^4.4.
|
|
36
|
-
"@smithy/core": "^3.23.
|
|
37
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
38
|
-
"@smithy/hash-node": "^4.2.
|
|
39
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
40
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
42
|
-
"@smithy/middleware-retry": "^4.4.
|
|
43
|
-
"@smithy/middleware-serde": "^4.2.
|
|
44
|
-
"@smithy/middleware-stack": "^4.2.
|
|
45
|
-
"@smithy/node-config-provider": "^4.3.
|
|
46
|
-
"@smithy/node-http-handler": "^4.4.
|
|
47
|
-
"@smithy/protocol-http": "^5.3.
|
|
48
|
-
"@smithy/smithy-client": "^4.12.
|
|
49
|
-
"@smithy/types": "^4.13.
|
|
50
|
-
"@smithy/url-parser": "^4.2.
|
|
24
|
+
"@aws-sdk/core": "^3.973.20",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "^3.972.21",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "^3.972.8",
|
|
27
|
+
"@aws-sdk/middleware-logger": "^3.972.8",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "^3.972.8",
|
|
29
|
+
"@aws-sdk/middleware-user-agent": "^3.972.21",
|
|
30
|
+
"@aws-sdk/region-config-resolver": "^3.972.8",
|
|
31
|
+
"@aws-sdk/types": "^3.973.6",
|
|
32
|
+
"@aws-sdk/util-endpoints": "^3.996.5",
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "^3.972.8",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "^3.973.7",
|
|
35
|
+
"@smithy/config-resolver": "^4.4.11",
|
|
36
|
+
"@smithy/core": "^3.23.11",
|
|
37
|
+
"@smithy/fetch-http-handler": "^5.3.15",
|
|
38
|
+
"@smithy/hash-node": "^4.2.12",
|
|
39
|
+
"@smithy/invalid-dependency": "^4.2.12",
|
|
40
|
+
"@smithy/middleware-content-length": "^4.2.12",
|
|
41
|
+
"@smithy/middleware-endpoint": "^4.4.25",
|
|
42
|
+
"@smithy/middleware-retry": "^4.4.42",
|
|
43
|
+
"@smithy/middleware-serde": "^4.2.14",
|
|
44
|
+
"@smithy/middleware-stack": "^4.2.12",
|
|
45
|
+
"@smithy/node-config-provider": "^4.3.12",
|
|
46
|
+
"@smithy/node-http-handler": "^4.4.16",
|
|
47
|
+
"@smithy/protocol-http": "^5.3.12",
|
|
48
|
+
"@smithy/smithy-client": "^4.12.5",
|
|
49
|
+
"@smithy/types": "^4.13.1",
|
|
50
|
+
"@smithy/url-parser": "^4.2.12",
|
|
51
51
|
"@smithy/util-base64": "^4.3.2",
|
|
52
52
|
"@smithy/util-body-length-browser": "^4.2.2",
|
|
53
53
|
"@smithy/util-body-length-node": "^4.2.3",
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^4.3.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
56
|
-
"@smithy/util-endpoints": "^3.3.
|
|
57
|
-
"@smithy/util-middleware": "^4.2.
|
|
58
|
-
"@smithy/util-retry": "^4.2.
|
|
59
|
-
"@smithy/util-stream": "^4.5.
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^4.3.41",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^4.2.44",
|
|
56
|
+
"@smithy/util-endpoints": "^3.3.3",
|
|
57
|
+
"@smithy/util-middleware": "^4.2.12",
|
|
58
|
+
"@smithy/util-retry": "^4.2.12",
|
|
59
|
+
"@smithy/util-stream": "^4.5.19",
|
|
60
60
|
"@smithy/util-utf8": "^4.2.2",
|
|
61
61
|
"tslib": "^2.6.2"
|
|
62
62
|
},
|