Skip to content

Commit

Permalink
docs(middleware-compression): add deprecation messages (#5659)
Browse files Browse the repository at this point in the history
  • Loading branch information
trivikr authored Jan 9, 2024
1 parent 3c249d0 commit 5696dd1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions packages/middleware-compression/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Middleware and Plugin for request compression.

> An internal package
> Deprecated. Use [@smithy/middleware-compression](https://www.npmjs.com/package/@smithy/middleware-compression) instead.
## Usage

You probably shouldn't, at least directly.
The `@aws-sdk/middleware-compression` was never used in AWS SDK for JavaScript (v3). It was replaced by `@smithy/middleware-compression` in the early stage of development. Please use `@smithy/middleware-compression` instead.
2 changes: 1 addition & 1 deletion packages/middleware-compression/src/configurations.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { BodyLengthCalculator } from "@smithy/types";

/**
* @public
* @deprecated Use {@link @smithy/middleware-compression#CompressionInputConfig} instead.
*/
export interface CompressionInputConfig {
/**
Expand Down

0 comments on commit 5696dd1

Please sign in to comment.