diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/SmithyCoreSubmodules.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/SmithyCoreSubmodules.java index d2e8209d6fb..796c7b9efd8 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/SmithyCoreSubmodules.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/SmithyCoreSubmodules.java @@ -5,6 +5,21 @@ package software.amazon.smithy.typescript.codegen; +/** + * This is an enum-like submodule list to be used with + * + * TypeScriptWriter::addImportSubmodule( + * Dependency == "cbor", + * null (no alias), + * PackageContainer == "@smithy/core", + * SmithyCoreSubmodules.CBOR == "/cbor" + * ); + * + * The intended result is e.g. + * ```ts + * import { cbor } from "@smithy/core/cbor"; + * ``` + */ public final class SmithyCoreSubmodules { public static final String CBOR = "/cbor";