Skip to content

Commit

Permalink
feat(cbor): add doc block to submodule enum
Browse files Browse the repository at this point in the history
  • Loading branch information
kuhe committed Aug 14, 2024
1 parent 1fcf98b commit ce9edcf
Showing 1 changed file with 15 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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";

Expand Down

0 comments on commit ce9edcf

Please sign in to comment.