From 5696dd1a5f346576481d5d1fc5ab64a5f11bff98 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Tue, 9 Jan 2024 13:00:29 -0800 Subject: [PATCH] docs(middleware-compression): add deprecation messages (#5659) --- packages/middleware-compression/README.md | 4 ++-- packages/middleware-compression/src/configurations.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/middleware-compression/README.md b/packages/middleware-compression/README.md index 936b088b0ba8f..d03f71703abeb 100644 --- a/packages/middleware-compression/README.md +++ b/packages/middleware-compression/README.md @@ -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. diff --git a/packages/middleware-compression/src/configurations.ts b/packages/middleware-compression/src/configurations.ts index e25c1e23bc337..32301607aa14c 100644 --- a/packages/middleware-compression/src/configurations.ts +++ b/packages/middleware-compression/src/configurations.ts @@ -1,7 +1,7 @@ import { BodyLengthCalculator } from "@smithy/types"; /** - * @public + * @deprecated Use {@link @smithy/middleware-compression#CompressionInputConfig} instead. */ export interface CompressionInputConfig { /**