From 8ad6b688a7cbb959b2d29e660c3642e4d186bb6e Mon Sep 17 00:00:00 2001 From: chrisradek Date: Mon, 23 Oct 2017 08:04:32 -0700 Subject: [PATCH] Adds Angular configuration to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index fc5f70c8c7..fe7c2b807b 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,14 @@ var AWS = require('aws-sdk/global'); var S3 = require('aws-sdk/clients/s3'); ``` +### With Angular +Due to the SDK's reliance on node.js typings, you may encounter compilation +[issues](https://github.com/aws/aws-sdk-js/issues/1271) when using the +typings provided by the SDK in an Angular project created using the Angular CLI. + +To resolve these issues, either add `"types": ["node"]` to the project's `tsconfig.app.json` +file, or remove the `"types"` field entirely. + ### Known Limitations There are a few known limitations with the bundled TypeScript definitions at this time: