| 1 | import type * as codeartifact from "@distilled.cloud/aws/codeartifact"; |
| 2 | import type * as Effect from "effect/Effect"; |
| 3 | import * as Binding from "../../Binding.ts"; |
| 4 | import type { Repository } from "./Repository.ts"; |
| 5 | |
| 6 | /** |
| 7 | * Request for {@link GetPackageVersionReadme} — `domain`, `domainOwner`, and |
| 8 | * `repository` are injected from the bound {@link Repository}. |
| 9 | */ |
| 10 | export interface GetPackageVersionReadmeRequest extends Omit< |
| 11 | codeartifact.GetPackageVersionReadmeRequest, |
| 12 | "domain" | "domainOwner" | "repository" |
| 13 | > {} |
| 14 | |
| 15 | /** |
| 16 | * Runtime binding for `codeartifact:GetPackageVersionReadme`. |
| 17 | * |
| 18 | * Reads a package version's readme, where the format supports one. Provide the implementation with |
| 19 | * `Effect.provide(AWS.CodeArtifact.GetPackageVersionReadmeHttp)`. |
| 20 | * ### Inspecting Package Versions |
| 21 | * **Example:** Get a Version's Readme |
| 22 | * ```typescript |
| 23 | * const getReadme = yield* AWS.CodeArtifact.GetPackageVersionReadme(repo); |
| 24 | * |
| 25 | * const res = yield* getReadme({ |
| 26 | * format: "npm", |
| 27 | * package: "left-pad", |
| 28 | * packageVersion: "1.3.0", |
| 29 | * }); |
| 30 | * console.log(res.readme); |
| 31 | * ``` |
| 32 | * |
| 33 | * @binding |
| 34 | */ |
| 35 | export interface GetPackageVersionReadme extends Binding.Service< |
| 36 | GetPackageVersionReadme, |
| 37 | "AWS.CodeArtifact.GetPackageVersionReadme", |
| 38 | ( |
| 39 | repository: Repository, |
| 40 | ) => Effect.Effect< |
| 41 | ( |
| 42 | request: GetPackageVersionReadmeRequest, |
| 43 | ) => Effect.Effect< |
| 44 | codeartifact.GetPackageVersionReadmeResult, |
| 45 | codeartifact.GetPackageVersionReadmeError |
| 46 | > |
| 47 | > |
| 48 | > {} |
| 49 | |
| 50 | export const GetPackageVersionReadme = Binding.Service<GetPackageVersionReadme>( |
| 51 | "AWS.CodeArtifact.GetPackageVersionReadme", |
| 52 | ); |