|
16 | 16 | > **Note** |
17 | 17 | > aws-amplify 6 has been released. If you are looking for upgrade guidance [click here](#notice) |
18 | 18 |
|
| 19 | +> **⚠️ Deprecation Notice** |
| 20 | +> **All AWS Amplify JavaScript library versions other than v5 and v6 are deprecated.** |
| 21 | +> Only **v5.x.x** and **v6.x.x** are actively supported. Versions **v4 and below** are deprecated. If you are using any version other than v5 or v6, we strongly recommend upgrading to v6 as soon as possible. |
| 22 | +
|
19 | 23 | ### AWS Amplify is a JavaScript library for frontend and mobile developers building cloud-enabled applications |
20 | 24 |
|
21 | 25 | AWS Amplify provides a declarative and easy-to-use interface across different categories of cloud operations. AWS Amplify goes well with any JavaScript based frontend workflow and React Native for mobile developers. |
@@ -148,42 +152,6 @@ If you are using AWS Amplify JavaScript library v4 and below, we strongly recomm |
148 | 152 | + Auth.signIn(...); |
149 | 153 | ``` |
150 | 154 |
|
151 | | -### Amplify 4.x.x has breaking changes for React Native. Please see the breaking changes below: |
152 | | - |
153 | | -- If you are using React Native (vanilla or Expo), you will need to add the following React Native community dependencies: |
154 | | - - `@react-native-community/netinfo` |
155 | | - - `@react-native-async-storage/async-storage` |
156 | | - |
157 | | -``` |
158 | | -// React Native |
159 | | -yarn add aws-amplify amazon-cognito-identity-js @react-native-community/netinfo @react-native-async-storage/async-storage |
160 | | -npx pod-install |
161 | | -
|
162 | | -// Expo |
163 | | -yarn add aws-amplify @react-native-community/netinfo @react-native-async-storage/async-storage |
164 | | -``` |
165 | | - |
166 | | -### Amplify 3.x.x has breaking changes. Please see the breaking changes below: |
167 | | - |
168 | | -- `AWS.credentials` and `AWS.config` don’t exist anymore in Amplify JavaScript. |
169 | | - - Both options will not be available to use in version 3. You will not be able to use and set your own credentials. |
170 | | - - For more information on this change, please see the [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-js-v3/#configuration) |
171 | | -- `aws-sdk@2.x` has been removed from `Amplify@3.x.x` in favor of [version 3 of aws-sdk-js](https://github.com/aws/aws-sdk-js-v3). We recommend to migrate to [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) if you rely on AWS services that are not supported by Amplify, since [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) is imported modularly. |
172 | | - |
173 | | -If you can't migrate to [aws-sdk-js-v3](https://github.com/aws/aws-sdk-js-v3) or rely on aws-sdk@2.x, you will need to import it separately. |
174 | | - |
175 | | -- If you are using exported paths within your Amplify JS application, (e.g. `import from "@aws-amplify/analytics/lib/Analytics"`) this will now break and no longer will be supported. You will need to change to named imports: |
176 | | - |
177 | | - ```js |
178 | | - import { Analytics } from 'aws-amplify'; |
179 | | - ``` |
180 | | - |
181 | | -- If you are using categories as `Amplify.<Category>`, this will no longer work and we recommend to import the category you are needing to use: |
182 | | - |
183 | | - ```js |
184 | | - import { Auth } from 'aws-amplify'; |
185 | | - ``` |
186 | | - |
187 | 155 | ### DataStore Docs |
188 | 156 |
|
189 | 157 | For more information on contributing to DataStore / how DataStore works, see the [DataStore Docs](packages/datastore/README.md) |
0 commit comments