Class Container

Hierarchy

Container

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Container(instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>, data: RawContainer): Container

- Defined in modules/docker/container.ts:22
Parameters
- instance: Unraid<Executor<ExecutorConfigType>, ExecutorConfigType>
- data: RawContainer
Returns Container

Properties

Readonly data

data: RawContainer

Readonly id

id: string

Accessors

created

get created(): Date

- Defined in modules/docker/container.ts:77
Returns Date

name

get name(): string

- Defined in modules/docker/container.ts:28
Returns string

state

get state(): ContainerStates

- Defined in modules/docker/container.ts:73
Returns ContainerStates

Methods

getImage

getImage(ignoreCache?: boolean): Promise<ContainerImage>

- Defined in modules/docker/container.ts:39
Returns the container image as base64 encoded image and it's SHA512 hash. Falls back to the default question logo in case no icon is found.

Parameters
- Optional ignoreCache: boolean
Returns Promise<ContainerImage>

getImageChecksum

getImageChecksum(): Promise<string>

- Defined in modules/docker/container.ts:59
Returns the SHA512 of the base64 encoded icon

Returns Promise<string>

stop

stop(): Promise<void>

- Defined in modules/docker/container.ts:81
Returns Promise<void>

Generated using TypeDoc