Class Client

Hierarchy

Client

Index

Constructors

constructor

Methods

Constructors

constructor

new Client(opts?: ClientOptions): Client

- Defined in src/client.ts:12
Parameters
- Optional opts: ClientOptions
Returns Client

Methods

copy

copy(src: string | Reference, dest: string | Reference): Promise<void>

- Defined in src/client.ts:93
Copies an image (manifest or index) to another location.

NOTE: Only supports copying within a repository (i.e., to duplicate a tag). All blobs must already be uploaded to the repository.

Parameters
- src: string | Reference
- dest: string | Reference
Returns Promise<void>

get

get(spec: string | Reference): Promise<Manifest | Index>

- Defined in src/client.ts:24
Parameters
- spec: string | Reference
Returns Promise<Manifest | Index>

getBlob

getBlob(spec: string | Repository, digest: string): Promise<Response>

- Defined in src/client.ts:80
Parameters
- spec: string | Repository
- digest: string
Returns Promise<Response>

getConfig

getConfig(spec: string | Reference, platform?: string | Platform): Promise<ImageConfig>

- Defined in src/client.ts:50
Parameters
- spec: string | Reference
- Optional platform: string | Platform
Returns Promise<ImageConfig>

getDigest

getDigest(spec: string | Reference): Promise<string>

- Defined in src/client.ts:64
Parameters
- spec: string | Reference
Returns Promise<string>

getManifest

getManifest(spec: string | Reference, platform?: string | Platform): Promise<Manifest>

- Defined in src/client.ts:31
Parameters
- spec: string | Reference
- Optional platform: string | Platform
Returns Promise<Manifest>

Generated using TypeDoc