dockside

Index

Type aliases

Annotations

Annotations: Record<string, string>

Identifier

Identifier: { type: "tag"; value: string } | { type: "digest"; value: string }

Identifier completes an image reference with a tag (e.g., :latest) or digest (e.g., @sha256:...).

Resource

Resource: Registry | Repository | Reference

A Resource is a resource that can be authenticated against.

Variables

defaultRegistry

defaultRegistry: "docker.io" = 'docker.io'

defaultRegistryHost

defaultRegistryHost: string = ...

Functions

Const isIndex

isIndex(resource: Manifest | Index): resource is Index

- Defined in src/types/index.ts:14
Parameters
- resource: Manifest | Index
Returns resource is Index

Const isLocalRegistry

isLocalRegistry(name: string): boolean

- Defined in src/ref.ts:191
Parameters
- name: string
Returns boolean

Const isManifest

isManifest(resource: Manifest | Index): resource is Manifest

- Defined in src/types/index.ts:11
Parameters
- resource: Manifest | Index
Returns resource is Manifest

Generated using TypeDoc