Skip to content

Commit 99c3823

Browse files
AllanZhengYPAllanZhengYP
authored
docs: add notes to discourage external usage of dependencies (#1241)
* docs: add notes to discourage external usage of dependencies
1 parent 9ab7ef4 commit 99c3823

File tree

33 files changed

+201
-3
lines changed

33 files changed

+201
-3
lines changed

‎packages/body-checksum-browser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/body-checksum-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-browser)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/body-checksum-browser.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-browser)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/body-checksum-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/body-checksum-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/body-checksum-node.svg)](https://www.npmjs.com/package/@aws-sdk/body-checksum-node)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/chunked-blob-reader-native/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader-native/beta.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader-native)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader-native.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader-native)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/chunked-blob-reader/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-blob-reader/beta.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-blob-reader.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-blob-reader)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/chunked-stream-reader-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,9 @@
66
Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer interally before calling the supplied function.
77

88
This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes.
9+
10+
> An internal package
11+
12+
## Usage
13+
14+
You probably shouldn't, at least directly.

‎packages/client-documentation-generator/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-documentation-generator/beta.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-documentation-generator.svg)](https://www.npmjs.com/package/@aws-sdk/client-documentation-generator)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/config-resolver/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/config-resolver/beta.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/config-resolver)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/eventstream-handler-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-handler-node/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-handler-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-handler-node.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-handler-node)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/eventstream-serde-browser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-browser/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-browser.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-browser)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/eventstream-serde-config-resolver/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver/alpha.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-config-resolver)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/eventstream-serde-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-node.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-node)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/eventstream-serde-universal/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/eventstream-serde-universal/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-universal)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/eventstream-serde-universal.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/eventstream-serde-universal)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/hash-blob-browser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-blob-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-blob-browser.svg)](https://www.npmjs.com/package/@aws-sdk/hash-blob-browser)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/hash-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/hash-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/hash-node.svg)](https://www.npmjs.com/package/@aws-sdk/hash-node)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/hash-stream-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,9 @@
66
A utility for calculating the hash of Node.JS readable streams. This package is
77
currently only compatible with file streams, as no other stream type can be
88
replayed.
9+
10+
> An internal package
11+
12+
## Usage
13+
14+
You probably shouldn't, at least directly.

‎packages/invalid-dependency/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/invalid-dependency/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/invalid-dependency)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/invalid-dependency.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/invalid-dependency)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/is-array-buffer/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/is-array-buffer/beta.svg)](https://www.npmjs.com/package/@aws-sdk/is-array-buffer)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/is-array-buffer.svg)](https://www.npmjs.com/package/@aws-sdk/is-array-buffer)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/md5-js/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/md5-js/beta.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/md5-js.svg)](https://www.npmjs.com/package/@aws-sdk/md5-js)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/property-provider/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/property-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/property-provider.svg)](https://www.npmjs.com/package/@aws-sdk/property-provider)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/querystring-builder/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-builder/beta.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-builder.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-builder)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/querystring-parser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/querystring-parser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/querystring-parser.svg)](https://www.npmjs.com/package/@aws-sdk/querystring-parser)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/region-provider/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/region-provider/beta.svg)](https://www.npmjs.com/package/@aws-sdk/region-provider)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/region-provider.svg)](https://www.npmjs.com/package/@aws-sdk/region-provider)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/sha256-tree-hash/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/sha256-tree-hash/beta.svg)](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/sha256-tree-hash.svg)](https://www.npmjs.com/package/@aws-sdk/sha256-tree-hash)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/smithy-client/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/@aws-sdk/smithy-client/beta.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/smithy-client)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/@aws-sdk/smithy-client.svg)](https://www.npmjs.com/package/@aws-sdk/@aws-sdk/smithy-client)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/url-parser-browser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/url-parser-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-browser)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/url-parser-browser.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-browser)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/url-parser-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/url-parser-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/url-parser-node.svg)](https://www.npmjs.com/package/@aws-sdk/url-parser-node)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/util-body-length-browser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,9 @@
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-body-length-browser.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-browser)
55

66
Determines the length of a request body in browsers
7+
8+
> An internal package
9+
10+
## Usage
11+
12+
You probably shouldn't, at least directly.

‎packages/util-body-length-node/README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# @aws-sdk/util-body-length-node
22

3-
Determines the length of a request body in node.js
4-
53
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-body-length-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-node)
64
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-body-length-node.svg)](https://www.npmjs.com/package/@aws-sdk/util-body-length-node)
5+
6+
Determines the length of a request body in node.js
7+
8+
> An internal package
9+
10+
## Usage
11+
12+
You probably shouldn't, at least directly.

‎packages/util-buffer-from/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-buffer-from/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-buffer-from)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-buffer-from.svg)](https://www.npmjs.com/package/@aws-sdk/util-buffer-from)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/util-uri-escape/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# util-uri-encode
1+
# util-uri-escape
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-uri-escape/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-uri-escape.svg)](https://www.npmjs.com/package/@aws-sdk/util-uri-escape)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/util-user-agent-browser/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-user-agent-browser/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-user-agent-browser.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-browser)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/util-user-agent-node/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/util-user-agent-node/beta.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/util-user-agent-node.svg)](https://www.npmjs.com/package/@aws-sdk/util-user-agent-node)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

‎packages/xml-builder/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,9 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@aws-sdk/xml-builder/beta.svg)](https://www.npmjs.com/package/@aws-sdk/xml-builder)
44
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/xml-builder.svg)](https://www.npmjs.com/package/@aws-sdk/xml-builder)
5+
6+
> An internal package
7+
8+
## Usage
9+
10+
You probably shouldn't, at least directly.

0 commit comments

Comments
 (0)