Installing the AWS Encryption SDK for JavaScript
The AWS Encryption SDK for JavaScript consists of a collection of interdependent modules. Several of the
modules are just collections of modules that are designed to work together. Some modules are
designed to work independently. A few modules are required for all implementations; a few others
are required only for special cases. For information about the modules in the AWS Encryption SDK for
JavaScript, see Modules in the AWS Encryption SDK for JavaScript and the
README.md file in each of the modules in the aws-encryption-sdk-javascript
Note
All versions of the AWS Encryption SDK for JavaScript earlier than 2.0.0 are in the end-of-support phase.
You can safely update from version 2.0.x and later to the latest version of the AWS Encryption SDK for JavaScript without any code or data changes. However, new security features introduced in version 2.0.x are not backward-compatible. To update from versions earlier than 1.7.x to version 2.0.x and later, you must first update to the latest 1.x version of the AWS Encryption SDK for JavaScript. For details, see Migrating your AWS Encryption SDK.
To install the modules, use the npm package
manager
For example, to install the client-node module, which includes all of the
modules you need to program with the AWS Encryption SDK for JavaScript in Node.js, use the following
command.
npm install @aws-crypto/client-node
To install the client-browser module, which includes all of the modules you
need to program with the AWS Encryption SDK for JavaScript in the browser, use the following command.
npm install @aws-crypto/client-browser
For working examples of how to use the AWS Encryption SDK for JavaScript, see the examples in the
example-node and example-browser modules in the aws-encryption-sdk-javascript
