Class DockerRegistry

Since

5.4.0

Version

2023-12-07

Index

Constructors

Methods

GetImageManifest ListImages ListImageWithTags ListTags

Constructors

constructor

new DockerRegistry(
url: string,
credentials?: { password: string; username: string },
): DockerRegistry
Parameters
- url: string
- Optionalcredentials: { password: string; username: string }
Returns DockerRegistry
- Defined in src/DockerRegistry.ts:29

Methods

GetImageManifest

GetImageManifest(
name: string,
reference: string,
): Promise<undefined | { name: string; tags: string[] }>
Pulling an Image Manifest
Parameters
- name: string
- reference: string
Returns Promise<undefined | { name: string; tags: string[] }>
See
https://distribution.github.io/distribution/spec/api/#pulling-an-image-manifest
- Defined in src/DockerRegistry.ts:57

ListImages

ListImages(): Promise<undefined | string[]>
Returns Promise<undefined | string[]>
- Defined in src/DockerRegistry.ts:36

ListImageWithTags

ListImageWithTags(): Promise<{ name: string; tags: string[] }[]>
Returns Promise<{ name: string; tags: string[] }[]>
- Defined in src/DockerRegistry.ts:63

ListTags(
repository: string,
): Promise<undefined | { name: string; tags: string[] }>
Parameters
- repository: string
Returns Promise<undefined | { name: string; tags: string[] }>
- Defined in src/DockerRegistry.ts:47