@aws-sdk/chunked-stream-reader-node 3.972.3 → 3.972.5

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.
Files changed (2) hide show
  1. package/README.md +12 -5
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -3,12 +3,19 @@
3
3
  [![NPM version](https://img.shields.io/npm/v/@aws-sdk/chunked-stream-reader-node/latest.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-stream-reader-node)
4
4
  [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/chunked-stream-reader-node.svg)](https://www.npmjs.com/package/@aws-sdk/chunked-stream-reader-node)
5
5
 
6
- Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer internally before calling the supplied function.
6
+ ### :warning: Internal API :warning:
7
7
 
8
- This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes.
8
+ > This is an internal package.
9
+ > That means this is used as a dependency for other, public packages, but
10
+ > should not be taken directly as a dependency in your application's `package.json`.
9
11
 
10
- > An internal package
12
+ > If you are updating the version of this package, for example to bring in a
13
+ > bug-fix, you should do so by updating your application lockfile with
14
+ > e.g. `npm up @scope/package` or equivalent command in another
15
+ > package manager, rather than taking a direct dependency.
11
16
 
12
- ## Usage
17
+ ---
13
18
 
14
- You probably shouldn't, at least directly.
19
+ Exports a streamReader function that accepts a readable stream, a function to call on each chunk, and a chunk size in bytes to buffer internally before calling the supplied function.
20
+
21
+ This package is meant for the AWS SDK for JavaScript to enable reading a stream with consistent chunk sizes.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-sdk/chunked-stream-reader-node",
3
- "version": "3.972.3",
3
+ "version": "3.972.5",
4
4
  "scripts": {
5
5
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
6
6
  "build:cjs": "node ../../scripts/compilation/inline chunked-stream-reader-node",
@@ -36,7 +36,7 @@
36
36
  "node": ">=20.0.0"
37
37
  },
38
38
  "typesVersions": {
39
- "<4.0": {
39
+ "<4.5": {
40
40
  "dist-types/*": [
41
41
  "dist-types/ts3.4/*"
42
42
  ]