UNPKG

@types/dockerode/index.d.ts

Version:
69 kBTypeScriptView Raw
1/// <reference types="node" />
2
3import * as DockerModem from "docker-modem";
4import * as events from "events";
5import { ConnectConfig } from "ssh2";
6import * as stream from "stream";
7
8declare namespace Dockerode {
  class Container {
      constructor(modem: any, id: string);
11
      modem: any;
      id: string;
14
      inspect(options: ContainerInspectOptions, callback: Callback<ContainerInspectInfo>): void;
      inspect(callback: Callback<ContainerInspectInfo>): void;
      inspect(options?: ContainerInspectOptions): Promise<ContainerInspectInfo>;
18
      rename(options: {}, callback: Callback<any>): void;
      rename(options: {}): Promise<any>;
21
      update(options: {}, callback: Callback<any>): void;
      update(options: {}): Promise<any>;
24
      top(options: {}, callback: Callback<any>): void;
      top(callback: Callback<any>): void;
      top(options?: {}): Promise<any>;
28
      changes(options: {}, callback: Callback<any>): void;
      changes(callback: Callback<any>): void;
      changes(options?: {}): Promise<any>;
32
      export(options: {}, callback: Callback<NodeJS.ReadableStream>): void;
      export(callback: Callback<NodeJS.ReadableStream>): void;
      export(options?: {}): Promise<NodeJS.ReadableStream>;
36
      start(options: ContainerStartOptions, callback: Callback<any>): void;
      start(callback: Callback<any>): void;
      start(options?: ContainerStartOptions): Promise<any>;
40
      pause(options: {}, callback: Callback<any>): void;
      pause(callback: Callback<any>): void;
      pause(options?: {}): Promise<any>;
44
      unpause(options: {}, callback: Callback<any>): void;
      unpause(callback: Callback<any>): void;
      unpause(options?: {}): Promise<any>;
48
      exec(options: ExecCreateOptions, callback: Callback<Exec>): void;
      exec(options: ExecCreateOptions): Promise<Exec>;
51
      commit(options: {}, callback: Callback<any>): void;
      commit(callback: Callback<any>): void;
      commit(options?: {}): Promise<any>;
55
      stop(options: ContainerStopOptions, callback: Callback<any>): void;
      stop(callback: Callback<any>): void;
      stop(options?: ContainerStopOptions): Promise<any>;
59
      restart(options: {}, callback: Callback<any>): void;
      restart(callback: Callback<any>): void;
      restart(options?: {}): Promise<any>;
63
      kill(options: {}, callback: Callback<any>): void;
      kill(callback: Callback<any>): void;
      kill(options?: {}): Promise<any>;
67
      resize(options: {}, callback: Callback<any>): void;
      resize(callback: Callback<any>): void;
      resize(options?: {}): Promise<any>;
71
      wait(options: ContainerWaitOptions, callback: Callback<any>): void;
      wait(callback: Callback<any>): void;
      wait(options?: ContainerWaitOptions): Promise<any>;
75
      remove(options: ContainerRemoveOptions, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
79
      /** Deprecated since RAPI v1.20 */
      copy(options: {}, callback: Callback<any>): void;
      /** Deprecated since RAPI v1.20 */
      copy(callback: Callback<any>): void;
      /** Deprecated since RAPI v1.20 */
      copy(options?: {}): Promise<any>;
86
      getArchive(options: {}, callback: Callback<NodeJS.ReadableStream>): void;
      getArchive(options: {}): Promise<NodeJS.ReadableStream>;
89
      infoArchive(options: {}, callback: Callback<any>): void;
      infoArchive(options: {}): Promise<any>;
92
      /** @param file Filename (will read synchronously), Buffer or stream */
      putArchive(
          file: string | Buffer | NodeJS.ReadableStream,
          options: {},
          callback: Callback<NodeJS.WritableStream>,
      ): void;
      putArchive(file: string | Buffer | NodeJS.ReadableStream, options: {}): Promise<NodeJS.ReadWriteStream>;
100
      logs(options: ContainerLogsOptions & { follow?: false }, callback: Callback<Buffer>): void;
      logs(options: ContainerLogsOptions & { follow: true }, callback: Callback<NodeJS.ReadableStream>): void;
      logs(callback: Callback<Buffer>): void;
      logs(options?: ContainerLogsOptions & { follow?: false }): Promise<Buffer>;
      logs(options?: ContainerLogsOptions & { follow: true }): Promise<NodeJS.ReadableStream>;
106
      stats(options: { stream?: false; "one-shot"?: boolean }, callback: Callback<ContainerStats>): void;
      stats(options: { stream: true }, callback: Callback<NodeJS.ReadableStream>): void;
      stats(callback: Callback<ContainerStats>): void;
      stats(options?: { stream?: false; "one-shot"?: boolean }): Promise<ContainerStats>;
      stats(options?: { stream: true }): Promise<NodeJS.ReadableStream>;
112
      attach(options: ContainerAttachOptions, callback: Callback<NodeJS.ReadWriteStream>): void;
      attach(options: ContainerAttachOptions): Promise<NodeJS.ReadWriteStream>;
  }
116
  class Image {
      constructor(modem: any, name: string);
119
      modem: any;
      id: string;
122
      inspect(callback: Callback<ImageInspectInfo>): void;
      inspect(): Promise<ImageInspectInfo>;
125
      history(callback: Callback<any>): void;
      history(): Promise<any>;
128
      get(callback: Callback<NodeJS.ReadableStream>): void;
      get(): Promise<NodeJS.ReadableStream>;
131
      push(options: ImagePushOptions, callback: Callback<NodeJS.ReadableStream>): void;
      push(callback: Callback<NodeJS.ReadableStream>): void;
      push(options?: ImagePushOptions): Promise<NodeJS.ReadableStream>;
135
      tag(options: ImageTagOptions, callback: Callback<any>): void;
      tag(callback: Callback<any>): void;
      tag(options?: ImageTagOptions): Promise<any>;
139
      remove(options: ImageRemoveOptions, callback: Callback<ImageRemoveInfo>): void;
      remove(callback: Callback<ImageRemoveInfo>): void;
      remove(options?: {}): Promise<any>;
143
      distribution(options: ImageDistributionOptions, callback: Callback<ImageDistributionInfo>): void;
      distribution(callback: Callback<ImageDistributionInfo>): void;
      distribution(options?: ImageDistributionOptions): Promise<ImageDistributionInfo>;
  }
148
  class Volume {
      constructor(modem: any, name: string);
151
      modem: any;
      name: string;
154
      inspect(options: {}, callback: Callback<VolumeInspectInfo>): void;
      inspect(callback: Callback<VolumeInspectInfo>): void;
      inspect(options?: {}): Promise<VolumeInspectInfo>;
158
      remove(options: VolumeRemoveOptions, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: VolumeRemoveOptions): Promise<any>;
  }
163
  class Service {
      constructor(modem: any, id: string);
166
      modem: any;
      id: string;
169
      inspect(options: {}, callback: Callback<any>): void;
      inspect(callback: Callback<any>): void;
      inspect(options?: {}): Promise<any>;
173
      remove(options: {}, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
177
      update(options: {}, callback: Callback<any>): void;
      update(options: {}): Promise<any>;
180
      logs(options: ContainerLogsOptions, callback: Callback<NodeJS.ReadableStream>): void;
      logs(callback: Callback<NodeJS.ReadableStream>): void;
      logs(options?: ContainerLogsOptions): Promise<NodeJS.ReadableStream>;
  }
185
  class Task {
      constructor(modem: any, id: string);
188
      modem: any;
      id: string;
191
      inspect(options: {}, callback: Callback<any>): void;
      inspect(callback: Callback<any>): void;
      inspect(options?: {}): Promise<any>;
  }
196
  class Node {
      constructor(modem: any, id: string);
199
      modem: any;
      id: string;
202
      inspect(options: {}, callback: Callback<any>): void;
      inspect(callback: Callback<any>): void;
      inspect(options?: {}): Promise<any>;
206
      update(options: {}, callback: Callback<any>): void;
      update(callback: Callback<any>): void;
      update(options?: {}): Promise<any>;
210
      remove(options: {}, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
  }
215
  class Plugin {
      constructor(modem: any, name: string, remote?: any);
218
      modem: any;
      name: string;
      remote: any;
222
      inspect(options: {}, callback: Callback<PluginInspectInfo>): void;
      inspect(callback: Callback<PluginInspectInfo>): void;
      inspect(options?: {}): Promise<PluginInspectInfo>;
226
      remove(options: {}, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
230
      privileges(options: {}, callback: Callback<any>): void;
      privileges(callback: Callback<any>): void;
      privileges(options?: {}): Promise<any>;
234
      pull(options: {}, callback: Callback<any>): void;
      pull(options: {}): Promise<any>;
237
      enable(options: {}, callback: Callback<any>): void;
      enable(callback: Callback<any>): void;
      enable(options?: {}): Promise<any>;
241
      disable(options: {}, callback: Callback<any>): void;
      disable(callback: Callback<any>): void;
      disable(options?: {}): Promise<any>;
245
      push(options: {}, callback: Callback<any>): void;
      push(callback: Callback<any>): void;
      push(options?: {}): Promise<any>;
249
      configure(options: {}, callback: Callback<any>): void;
      configure(callback: Callback<any>): void;
      configure(options?: {}): Promise<any>;
253
      upgrade(auth: any, options: {}, callback: Callback<any>): void;
      upgrade(auth: any, callback: Callback<any>): void;
      upgrade(auth: any, options?: {}): Promise<any>;
  }
258
  class Secret {
      constructor(modem: any, id: string);
261
      modem: any;
      id: string;
264
      inspect(options: {}, callback: Callback<Secret>): void;
      inspect(callback: Callback<Secret>): void;
      inspect(options?: {}): Promise<Secret>;
268
      update(options: {}, callback: Callback<any>): void;
      update(callback: Callback<any>): void;
      update(options?: {}): Promise<any>;
272
      remove(options: {}, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
  }
277
  class Network {
      constructor(modem: any, id: string);
280
      modem: any;
      id: string;
283
      inspect(callback: Callback<any>): void;
      inspect(): Promise<any>;
286
      remove(options: {}, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
290
      connect(options: NetworkConnectOptions, callback: Callback<any>): void;
      connect(callback: Callback<any>): void;
      connect(options?: NetworkConnectOptions): Promise<any>;
294
      disconnect(options: {}, callback: Callback<any>): void;
      disconnect(callback: Callback<any>): void;
      disconnect(options?: {}): Promise<any>;
  }
299
  class Exec {
      constructor(modem: any, id: string);
302
      modem: any;
      id: string;
305
      inspect(options: ExecInspectOptions, callback: Callback<ExecInspectInfo>): void;
      inspect(callback: Callback<ExecInspectInfo>): void;
      inspect(options?: ExecInspectOptions): Promise<ExecInspectInfo>;
309
      start(options: ExecStartOptions, callback: Callback<stream.Duplex>): void;
      start(options: ExecStartOptions): Promise<stream.Duplex>;
312
      resize(options: {}, callback: Callback<any>): void;
      resize(options: {}): Promise<any>;
  }
316
  class Config {
      constructor(modem: any, id: string);
319
      modem: any;
      id: string;
322
      inspect(options: {}, callback: Callback<ConfigInfo>): void;
      inspect(callback: Callback<ConfigInfo>): void;
      inspect(options?: {}): Promise<ConfigInfo>;
326
      update(options: {}, callback: Callback<any>): void;
      update(callback: Callback<any>): void;
      update(options?: {}): Promise<any>;
330
      remove(options: {}, callback: Callback<any>): void;
      remove(callback: Callback<any>): void;
      remove(options?: {}): Promise<any>;
  }
335
  type Duration = number;
337
  interface ImageInfo {
      Id: string;
      ParentId: string;
      RepoTags: string[] | undefined;
      RepoDigests?: string[] | undefined;
      Created: number;
      Size: number;
      VirtualSize: number;
      SharedSize: number;
      Labels: { [label: string]: string };
      Containers: number;
  }
350
  interface ContainerInfo {
      Id: string;
      Names: string[];
      Image: string;
      ImageID: string;
      Command: string;
      Created: number;
      Ports: Port[];
      Labels: { [label: string]: string };
      State: string;
      Status: string;
      HostConfig: {
          NetworkMode: string;
      };
      NetworkSettings: {
          Networks: { [networkType: string]: NetworkInfo };
      };
      Mounts: Array<{
          Name?: string | undefined;
          Type: string;
          Source: string;
          Destination: string;
          Driver?: string | undefined;
          Mode: string;
          RW: boolean;
          Propagation: string;
      }>;
  }
379
  interface Port {
      IP: string;
      PrivatePort: number;
      PublicPort: number;
      Type: string;
  }
386
  interface NetworkInfo {
      IPAMConfig?: any;
      Links?: any;
      Aliases?: any;
      NetworkID: string;
      EndpointID: string;
      Gateway: string;
      IPAddress: string;
      IPPrefixLen: number;
      IPv6Gateway: string;
      GlobalIPv6Address: string;
      GlobalIPv6PrefixLen: number;
      MacAddress: string;
  }
401
  // Information returned from inspecting a network
  interface NetworkInspectInfo {
      Name: string;
      Id: string;
      Created: string;
      Scope: string;
      Driver: string;
      EnableIPv6: boolean;
      IPAM?: IPAM | undefined;
      Internal: boolean;
      Attachable: boolean;
      Ingress: boolean;
      ConfigFrom?: { Network: string } | undefined;
      ConfigOnly: boolean;
      Containers?: { [id: string]: NetworkContainer } | undefined;
      Options?: { [key: string]: string } | undefined;
      Labels?: { [key: string]: string } | undefined;
  }
420
  interface NetworkCreateOptions {
      Name: string;
      CheckDuplicate?: boolean | undefined;
      Driver?: string | undefined;
      Internal?: boolean | undefined;
      Attachable?: boolean | undefined;
      Ingress?: boolean | undefined;
      IPAM?: IPAM | undefined;
      EnableIPv6?: boolean | undefined;
      Options?: { [option: string]: string } | undefined;
      Labels?: { [label: string]: string } | undefined;
432
      abortSignal?: AbortSignal;
  }
435
  interface NetworkConnectOptions {
      Container?: string;
      EndpointConfig?: EndpointSettings | undefined;
  }
440
  interface NetworkContainer {
      Name: string;
      EndpointID: string;
      MacAddress: string;
      IPv4Address: string;
      IPv6Address: string;
  }
448
  /* tslint:disable:interface-name */
  interface IPAM {
      Driver: string;
      Config?: Array<{ [key: string]: string }> | undefined;
      Options?: { [key: string]: string } | undefined;
  }
  /* tslint:enable:interface-name */
456
  interface VolumeCreateOptions {
      Name?: string | undefined;
      Driver?: string | undefined;
      DriverOpts?: { [key: string]: string } | undefined;
      Labels?: { [label: string]: string } | undefined;
      abortSignal?: AbortSignal;
  }
464
  interface VolumePruneOptions {
      abortSignal?: AbortSignal;
      /**
       * Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
       * A dictionary of key/value list is also accepted.
       */
      filters?: string | { [key: string]: string[] };
  }
473
  interface VolumeRemoveOptions {
      abortSignal?: AbortSignal;
  }
477
  interface VolumeCreateResponse {
      Name: string;
      Driver: string;
      Mountpoint: string;
      CreatedAt?: string | undefined;
      Status?: { [key: string]: string } | undefined;
      Labels: { [label: string]: string };
      Scope: string;
      Options: { [key: string]: string };
      // Field is sometimes present, and sometimes null
      UsageData?:
          | {
              Size: number;
              RefCount: number;
          }
          | null
          | undefined;
  }
496
  interface VolumeInspectInfo {
      Name: string;
      Driver: string;
      Mountpoint: string;
      Status?: { [key: string]: string } | undefined;
      Labels: { [key: string]: string };
      Scope: "local" | "global";
      // Field is always present, but sometimes is null
      Options: { [key: string]: string } | null;
      // Field is sometimes present, and sometimes null
      UsageData?:
          | {
              Size: number;
              RefCount: number;
          }
          | null
          | undefined;
  }
515
  interface ContainerInspectInfo {
      Id: string;
      Created: string;
      Path: string;
      Args: string[];
      State: {
          Status: string;
          Running: boolean;
          Paused: boolean;
          Restarting: boolean;
          OOMKilled: boolean;
          Dead: boolean;
          Pid: number;
          ExitCode: number;
          Error: string;
          StartedAt: string;
          FinishedAt: string;
          Health?:
              | {
                  Status: string;
                  FailingStreak: number;
                  Log: Array<{
                      Start: string;
                      End: string;
                      ExitCode: number;
                      Output: string;
                  }>;
              }
              | undefined;
      };
      Image: string;
      ResolvConfPath: string;
      HostnamePath: string;
      HostsPath: string;
      LogPath: string;
      Name: string;
      RestartCount: number;
      Driver: string;
      Platform: string;
      MountLabel: string;
      ProcessLabel: string;
      AppArmorProfile: string;
      ExecIDs?: string[] | undefined;
      HostConfig: HostConfig;
      GraphDriver: {
          Name: string;
          Data: {
              DeviceId: string;
              DeviceName: string;
              DeviceSize: string;
          };
      };
      Mounts: Array<{
          Name?: string | undefined;
          Source: string;
          Destination: string;
          Mode: string;
          RW: boolean;
          Propagation: string;
      }>;
      Config: {
          Hostname: string;
          Domainname: string;
          User: string;
          AttachStdin: boolean;
          AttachStdout: boolean;
          AttachStderr: boolean;
          ExposedPorts: { [portAndProtocol: string]: {} };
          Tty: boolean;
          OpenStdin: boolean;
          StdinOnce: boolean;
          Env: string[];
          Cmd: string[];
          Image: string;
          Volumes: { [volume: string]: {} };
          WorkingDir: string;
          Entrypoint?: string | string[] | undefined;
          OnBuild?: any;
          Labels: { [label: string]: string };
      };
      NetworkSettings: {
          Bridge: string;
          SandboxID: string;
          HairpinMode: boolean;
          LinkLocalIPv6Address: string;
          LinkLocalIPv6PrefixLen: number;
          Ports: {
              [portAndProtocol: string]: Array<{
                  HostIp: string;
                  HostPort: string;
              }>;
          };
          SandboxKey: string;
          SecondaryIPAddresses?: any;
          SecondaryIPv6Addresses?: any;
          EndpointID: string;
          Gateway: string;
          GlobalIPv6Address: string;
          GlobalIPv6PrefixLen: number;
          IPAddress: string;
          IPPrefixLen: number;
          IPv6Gateway: string;
          MacAddress: string;
          Networks: {
              [type: string]: {
                  IPAMConfig?: any;
                  Links?: any;
                  Aliases?: any;
                  NetworkID: string;
                  EndpointID: string;
                  Gateway: string;
                  IPAddress: string;
                  IPPrefixLen: number;
                  IPv6Gateway: string;
                  GlobalIPv6Address: string;
                  GlobalIPv6PrefixLen: number;
                  MacAddress: string;
              };
          };
          Node?:
              | {
                  ID: string;
                  IP: string;
                  Addr: string;
                  Name: string;
                  Cpus: number;
                  Memory: number;
                  Labels: any;
              }
              | undefined;
      };
  }
648
  interface NetworkListOptions {
      /**
       * JSON encoded value of the filters (a `map[string][]string`) to process on the networks list.
       * A dictionary of key/value list is also accepted.
       */
      filters?: string | { [key: string]: string[] };
      abortSignal?: AbortSignal;
  }
657
  interface NetworkStats {
      [name: string]: {
          rx_bytes: number;
          rx_dropped: number;
          rx_errors: number;
          rx_packets: number;
          tx_bytes: number;
          tx_dropped: number;
          tx_errors: number;
          tx_packets: number;
          endpoint_id?: string; // not used on linux
          instance_id?: string; // not used on linux
      };
  }
672
  interface VolumeListOptions {
      abortSignal?: AbortSignal;
      /**
       * A JSON encoded value of the filters (a map[string][]string) to process on the volume list.
       */
      filters?: string | { [key: string]: string[] };
      /**
       * Show digest information as a RepoDigests field on each image.
       * @default false
       */
      digests?: boolean;
  }
685
  interface NodeListOptions {
      abortSignal?: AbortSignal;
      /**
       * Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).
       */
      filters?: string;
  }
693
  interface CPUUsage {
      percpu_usage: number[];
      usage_in_usermode: number;
      total_usage: number;
      usage_in_kernelmode: number;
  }
700
  interface ThrottlingData {
      periods: number;
      throttled_periods: number;
      throttled_time: number;
  }
706
  interface CPUStats {
      cpu_usage: CPUUsage;
      system_cpu_usage: number;
      online_cpus: number;
      throttling_data: ThrottlingData;
  }
713
  interface MemoryStats {
      // Linux Memory Stats
      stats: {
          total_pgmajfault: number;
          cache: number;
          mapped_file: number;
          total_inactive_file: number;
          pgpgout: number;
          rss: number;
          total_mapped_file: number;
          writeback: number;
          unevictable: number;
          pgpgin: number;
          total_unevictable: number;
          pgmajfault: number;
          total_rss: number;
          total_rss_huge: number;
          total_writeback: number;
          total_inactive_anon: number;
          rss_huge: number;
          hierarchical_memory_limit: number;
          total_pgfault: number;
          total_active_file: number;
          active_anon: number;
          total_active_anon: number;
          total_pgpgout: number;
          total_cache: number;
          inactive_anon: number;
          active_file: number;
          pgfault: number;
          inactive_file: number;
          total_pgpgin: number;
      };
      max_usage: number;
      usage: number;
      failcnt: number;
      limit: number;
751
      // Windows Memory Stats
      commitbytes?: number;
      commitpeakbytes?: number;
      privateworkingset?: number;
  }
757
  interface BlkioStatEntry {
      major: number;
      minor: number;
      op: string;
      value: number;
  }
764
  interface BlkioStats {
      io_service_bytes_recursive: BlkioStatEntry[];
      io_serviced_recursive: BlkioStatEntry[];
      io_queue_recursive: BlkioStatEntry[];
      io_service_time_recursive: BlkioStatEntry[];
      io_wait_time_recursive: BlkioStatEntry[];
      io_merged_recursive: BlkioStatEntry[];
      io_time_recursive: BlkioStatEntry[];
      sectors_recursive: BlkioStatEntry[];
  }
775
  interface StorageStats {
      read_count_normalized?: number;
      read_size_bytes?: number;
      write_count_normalized?: number;
      write_size_bytes?: number;
  }
782
  interface PidsStats {
      current?: number;
      limit?: number;
  }
787
  interface ContainerStats {
      read: string;
      preread: string;
      pids_stats?: PidsStats;
      blkio_stats?: BlkioStats;
      num_procs: number;
      storage_stats?: StorageStats;
      networks: NetworkStats;
      memory_stats: MemoryStats;
      cpu_stats: CPUStats;
      precpu_stats: CPUStats;
  }
800
  interface HostConfig {
      AutoRemove?: boolean | undefined;
      Binds?: string[] | undefined;
      ContainerIDFile?: string | undefined;
      LogConfig?:
          | {
              Type: string;
              Config: any;
          }
          | undefined;
      NetworkMode?: string | undefined;
      PortBindings?: any;
      RestartPolicy?: HostRestartPolicy | undefined;
      VolumeDriver?: string | undefined;
      VolumesFrom?: any;
      Mounts?: MountConfig | undefined;
      CapAdd?: any;
      CapDrop?: any;
      Dns?: any[] | undefined;
      DnsOptions?: any[] | undefined;
      DnsSearch?: string[] | undefined;
      ExtraHosts?: any;
      GroupAdd?: string[] | undefined;
      IpcMode?: string | undefined;
      Cgroup?: string | undefined;
      Links?: any;
      OomScoreAdj?: number | undefined;
      PidMode?: string | undefined;
      Privileged?: boolean | undefined;
      PublishAllPorts?: boolean | undefined;
      ReadonlyRootfs?: boolean | undefined;
      SecurityOpt?: any;
      StorageOpt?: { [option: string]: string } | undefined;
      Tmpfs?: { [dir: string]: string } | undefined;
      UTSMode?: string | undefined;
      UsernsMode?: string | undefined;
      ShmSize?: number | undefined;
      Sysctls?: { [index: string]: string } | undefined;
      Runtime?: string | undefined;
      ConsoleSize?: number[] | undefined;
      Isolation?: string | undefined;
      MaskedPaths?: string[] | undefined;
      ReadonlyPaths?: string[] | undefined;
      CpuShares?: number | undefined;
      CgroupParent?: string | undefined;
      BlkioWeight?: number | undefined;
      BlkioWeightDevice?: any;
      BlkioDeviceReadBps?: any;
      BlkioDeviceWriteBps?: any;
      BlkioDeviceReadIOps?: any;
      BlkioDeviceWriteIOps?: any;
      CpuPeriod?: number | undefined;
      CpuQuota?: number | undefined;
      CpusetCpus?: string | undefined;
      CpusetMems?: string | undefined;
      Devices?: any;
      DeviceCgroupRules?: string[] | undefined;
      DeviceRequests?: DeviceRequest[] | undefined;
      DiskQuota?: number | undefined;
      KernelMemory?: number | undefined;
      Memory?: number | undefined;
      MemoryReservation?: number | undefined;
      MemorySwap?: number | undefined;
      MemorySwappiness?: number | undefined;
      NanoCpus?: number | undefined;
      OomKillDisable?: boolean | undefined;
      Init?: boolean | undefined;
      PidsLimit?: number | undefined;
      Ulimits?: Ulimit[] | undefined;
      CpuCount?: number | undefined;
      CpuPercent?: number | undefined;
      CpuRealtimePeriod?: number | undefined;
      CpuRealtimeRuntime?: number | undefined;
  }
875
  interface ImageInspectInfo {
      Id: string;
      RepoTags: string[];
      RepoDigests: string[];
      Parent: string;
      Comment: string;
      Created: string;
      Container: string;
      ContainerConfig: {
          Hostname: string;
          Domainname: string;
          User: string;
          AttachStdin: boolean;
          AttachStdout: boolean;
          AttachStderr: boolean;
          ExposedPorts: { [portAndProtocol: string]: {} };
          Tty: boolean;
          OpenStdin: boolean;
          StdinOnce: boolean;
          Env: string[];
          Cmd: string[];
          ArgsEscaped: boolean;
          Image: string;
          Volumes: { [path: string]: {} };
          WorkingDir: string;
          Entrypoint?: string | string[] | undefined;
          OnBuild?: any[] | undefined;
          Labels: { [label: string]: string };
      };
      DockerVersion: string;
      Author: string;
      Config: {
          Hostname: string;
          Domainname: string;
          User: string;
          AttachStdin: boolean;
          AttachStdout: boolean;
          AttachStderr: boolean;
          ExposedPorts: { [portAndProtocol: string]: {} };
          Tty: boolean;
          OpenStdin: boolean;
          StdinOnce: boolean;
          Env: string[];
          Cmd: string[];
          ArgsEscaped: boolean;
          Image: string;
          Volumes: { [path: string]: {} };
          WorkingDir: string;
          Entrypoint?: string | string[] | undefined;
          OnBuild: any[];
          Labels: { [label: string]: string };
      };
      Architecture: string;
      Os: string;
      Size: number;
      VirtualSize: number;
      GraphDriver: {
          Name: string;
          Data: {
              DeviceId: string;
              DeviceName: string;
              DeviceSize: string;
          };
      };
      RootFS: {
          Type: string;
          Layers?: string[] | undefined;
          BaseLayer?: string | undefined;
      };
  }
946
  interface ImageBuildOptions {
      authconfig?: AuthConfig | undefined;
      registryconfig?: RegistryConfig | undefined;
      abortSignal?: AbortSignal;
951
      dockerfile?: string | undefined;
      t?: string | undefined;
      extrahosts?: string | undefined;
      remote?: string | undefined;
      q?: boolean | undefined;
      cachefrom?: string | undefined;
      pull?: string | undefined;
      rm?: boolean | undefined;
      forcerm?: boolean | undefined;
      memory?: number | undefined;
      memswap?: number | undefined;
      cpushares?: number | undefined;
      cpusetcpus?: number | undefined;
      cpuperiod?: number | undefined;
      cpuquota?: number | undefined;
      buildargs?: { [key: string]: string } | undefined;
      shmsize?: number | undefined;
      squash?: boolean | undefined;
      labels?: { [key: string]: string } | undefined;
      networkmode?: string | undefined;
      platform?: string | undefined;
      target?: string | undefined;
      outputs?: string | undefined;
      nocache?: boolean | undefined;
976
      /**
       * Version of the builder backend to use.
       *  - `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
       *  - `2` is [BuildKit](https://github.com/moby/buildkit)
       */
      version?: "1" | "2" | undefined;
  }
984
  interface ImageDistributionOptions {
      authconfig?: AuthConfig | undefined;
      abortSignal?: AbortSignal;
  }
989
  interface ImagePushOptions {
      tag?: string | undefined;
      authconfig?: AuthConfig | undefined;
      abortSignal?: AbortSignal;
  }
995
  interface ImageTagOptions {
      abortSignal?: AbortSignal;
      /**
       * The repository to tag in. For example, someuser/someimage.
       */
      repo: string;
      /**
       * The name of the new tag.
       */
      tag?: string;
  }
1007
  interface AuthConfig {
      username?: string;
      password?: string;
      auth?: string;
      serveraddress?: string;
      identitytoken?: string;
      registrytoken?: string;
      /** @deprecated */
      email?: string | undefined;
  }
1018
  interface RegistryConfig {
      [registryAddress: string]: {
          username: string;
          password: string;
      };
  }
1025
  interface PortBinding {
      HostIp?: string | undefined;
      HostPort?: string | undefined;
  }
1030
  interface PortMap {
      [key: string]: PortBinding[];
  }
1034
  interface HostRestartPolicy {
      Name: string;
      MaximumRetryCount?: number | undefined;
  }
1039
  type LoggingDriverType =
      | "json-file"
      | "syslog"
      | "journald"
      | "gelf"
      | "fluentd"
      | "awslogs"
      | "splunk"
      | "etwlogs"
      | "none";
1050
  interface LogConfig {
      Type: LoggingDriverType;
      Config?: { [key: string]: string } | undefined;
  }
1055
  interface DeviceMapping {
      PathOnHost: string;
      PathInContainer: string;
      CgroupPermissions: string;
  }
1061
  interface DeviceRequest {
      Driver?: string | undefined;
      Count?: number | undefined;
      DeviceIDs?: string[] | undefined;
      Capabilities?: string[][] | undefined;
      Options?: { [key: string]: string } | undefined;
  }
1069
  /* tslint:disable:interface-name */
  interface IPAMConfig {
      IPv4Address?: string | undefined;
      IPv6Address?: string | undefined;
      LinkLocalIPs?: string[] | undefined;
  }
  /* tslint:enable:interface-name */
1077
  interface EndpointSettings {
      IPAMConfig?: IPAMConfig | undefined;
      Links?: string[] | undefined;
      Aliases?: string[] | undefined;
      NetworkID?: string | undefined;
      EndpointID?: string | undefined;
      Gateway?: string | undefined;
      IPAddress?: string | undefined;
      IPPrefixLen?: number | undefined;
      IPv6Gateway?: string | undefined;
      GlobalIPv6Address?: string | undefined;
      GlobalIPV6PrefixLen?: number | undefined;
      MacAddress?: string | undefined;
      DriverOpts?: { [key: string]: string } | undefined;
  }
1093
  interface EndpointsConfig {
      [key: string]: EndpointSettings;
  }
1097
  interface ExecCreateOptions {
      AttachStdin?: boolean | undefined;
      AttachStdout?: boolean | undefined;
      AttachStderr?: boolean | undefined;
      DetachKeys?: string | undefined;
      Tty?: boolean | undefined;
      Env?: string[] | undefined;
      Cmd?: string[] | undefined;
      Privileged?: boolean | undefined;
      User?: string | undefined;
      WorkingDir?: string | undefined;
      abortSignal?: AbortSignal;
  }
1111
  interface ExecInspectInfo {
      CanRemove: boolean;
      DetachKeys: string;
      ID: string;
      Running: boolean;
      ExitCode: number | null;
      ProcessConfig: {
          privileged: boolean;
          user: string;
          tty: boolean;
          entrypoint: string;
          arguments: string[];
      };
      OpenStdin: boolean;
      OpenStderr: boolean;
      OpenStdout: boolean;
      ContainerID: string;
      Pid: number;
  }
1131
  interface ExecInspectOptions {
      abortSignal?: AbortSignal;
  }
1135
  interface ExecStartOptions {
      // hijack and stdin are used by docker-modem
      hijack?: boolean | undefined;
      stdin?: boolean | undefined;
      // Detach and Tty are used by Docker's API
      Detach?: boolean | undefined;
      Tty?: boolean | undefined;
      abortSignal?: AbortSignal;
  }
1145
  type MountType = "bind" | "volume" | "tmpfs";
1147
  type MountConsistency = "default" | "consistent" | "cached" | "delegated";
1149
  type MountPropagation = "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave";
1151
  interface MountSettings {
      Target: string;
      Source: string;
      Type: MountType;
      ReadOnly?: boolean | undefined;
      Consistency?: MountConsistency | undefined;
      BindOptions?:
          | {
              Propagation: MountPropagation;
          }
          | undefined;
      VolumeOptions?:
          | {
              NoCopy: boolean;
              Labels: { [label: string]: string };
              DriverConfig: {
                  Name: string;
                  Options: { [option: string]: string };
              };
          }
          | undefined;
      TmpfsOptions?:
          | {
              SizeBytes: number;
              Mode: number;
          }
          | undefined;
  }
1180
  type MountConfig = MountSettings[];
1182
  interface ContainerCreateOptions {
      name?: string | undefined;
      platform?: string | undefined;
      Hostname?: string | undefined;
      Domainname?: string | undefined;
      User?: string | undefined;
      ArgsEscaped?: boolean | undefined;
      AttachStdin?: boolean | undefined;
      AttachStdout?: boolean | undefined;
      AttachStderr?: boolean | undefined;
      Tty?: boolean | undefined;
      OpenStdin?: boolean | undefined;
      StdinOnce?: boolean | undefined;
      Env?: string[] | undefined;
      Cmd?: string[] | undefined;
      Entrypoint?: string | string[] | undefined;
      Image?: string | undefined;
      Labels?: { [label: string]: string } | undefined;
      Volumes?: { [volume: string]: {} } | undefined;
      WorkingDir?: string | undefined;
      NetworkDisabled?: boolean | undefined;
      MacAddress?: string | undefined;
      ExposedPorts?: { [port: string]: {} } | undefined;
      StopSignal?: string | undefined;
      StopTimeout?: number | undefined;
      Healthcheck?: HealthConfig | undefined;
      HostConfig?: HostConfig | undefined;
      OnBuild?: string[] | undefined;
      Shell?: string[] | undefined;
      NetworkingConfig?:
          | {
              EndpointsConfig?: EndpointsConfig | undefined;
          }
          | undefined;
      abortSignal?: AbortSignal;
  }
1219
  interface ContainerInspectOptions {
      abortSignal?: AbortSignal;
  }
1223
  interface ContainerStartOptions {
      detachKeys?: string;
      abortSignal?: AbortSignal;
  }
1228
  interface ContainerRemoveOptions {
      v?: boolean | undefined;
      force?: boolean | undefined;
      link?: boolean | undefined;
  }
1234
  interface KeyObject {
      pem: string | Buffer;
      passphrase?: string | undefined;
  }
1239
  interface DockerOptions {
      socketPath?: string | undefined;
      host?: string | undefined;
      port?: number | string | undefined;
      username?: string | undefined;
      headers?: { [name: string]: string };
      ca?: string | string[] | Buffer | Buffer[] | undefined;
      cert?: string | string[] | Buffer | Buffer[] | undefined;
      key?: string | string[] | Buffer | Buffer[] | KeyObject[] | undefined;
      protocol?: "https" | "http" | "ssh" | undefined;
      timeout?: number | undefined;
      version?: string | undefined;
      sshAuthAgent?: string | undefined;
      sshOptions?: ConnectConfig | undefined;
      Promise?: typeof Promise | undefined;
  }
1256
  interface GetEventsOptions {
      since?: number | undefined;
      until?: number | undefined;
      filters?:
          | string
          | {
              config?: string | undefined;
              container?: string[] | undefined;
              daemon?: string[] | undefined;
              event?: string[] | undefined;
              image?: string[] | undefined;
              label?: string[] | undefined;
              network?: string[] | undefined;
              node?: string[] | undefined;
              plugin?: string[] | undefined;
              scope?: Array<"local" | "swarm"> | undefined;
              secret?: string[] | undefined;
              service?: string[] | undefined;
              type?:
                  | Array<
                      | "container"
                      | "image"
                      | "volume"
                      | "network"
                      | "daemon"
                      | "plugin"
                      | "service"
                      | "node"
                      | "secret"
                      | "config"
                  >
                  | undefined;
              volume?: string[] | undefined;
          }
          | undefined;
      abortSignal?: AbortSignal;
  }
1294
  interface SecretVersion {
      Index: number;
  }
1298
  interface Annotations {
      Name?: string | undefined;
      Labels?: { [name: string]: string } | undefined;
  }
1303
  interface ResourceLimits {
      NanoCPUs?: number | undefined;
      MemoryBytes?: number | undefined;
      Pids?: number | undefined;
  }
1309
  interface NamedGenericResource {
      Kind?: string | undefined;
      Value?: string | undefined;
  }
1314
  interface DiscreteGenericResource {
      Kind?: string | undefined;
      Value?: number | undefined;
  }
1319
  type GenericResource = NamedGenericResource | DiscreteGenericResource;
1321
  interface TaskRestartPolicy {
      Condition?: string | undefined;
      Delay?: number | undefined;
      MaxAttempts?: number | undefined;
      Window?: number | undefined;
  }
1328
  interface Resources {
      NanoCPUs?: number | undefined;
      MemoryBytes?: number | undefined;
      GenericResources?: GenericResource[] | undefined;
  }
1334
  interface ResourceRequirements {
      Limits?: ResourceLimits | undefined;
      Reservations?: Resources | undefined;
  }
1339
  interface Placement {
      Constraints?: string[] | undefined;
      Preferences?: Array<{ Spread: { SpreadDescriptor: string } }> | undefined;
      MaxReplicas?: number | undefined;
      Platforms?:
          | Array<{
              Architecture: string;
              OS: string;
          }>
          | undefined;
  }
1351
  interface NetworkAttachmentConfig {
      Target?: string | undefined;
      Aliases?: string[] | undefined;
      DriverOpts?: { [key: string]: string } | undefined;
  }
1357
  interface Privileges {
      CredentialSpec?:
          | {
              Config?: string | undefined;
              File?: string | undefined;
              Registry?: string | undefined;
          }
          | undefined;
      SELinuxContext?:
          | {
              Disable?: boolean | undefined;
              User?: string | undefined;
              Role?: string | undefined;
              Type?: string | undefined;
              Level?: string | undefined;
          }
          | undefined;
  }
1376
  interface HealthConfig {
      Test?: string[] | undefined;
      Interval?: number | undefined;
      Timeout?: number | undefined;
      StartPeriod?: number | undefined;
      Retries?: number | undefined;
  }
1384
  interface DNSConfig {
      Nameservers?: string[] | undefined;
      Search?: string[] | undefined;
      Options?: string[] | undefined;
  }
1390
  interface ConfigReference {
      File?:
          | {
              Name?: string | undefined;
              UID?: string | undefined;
              GID?: string | undefined;
              Mode: number | undefined;
          }
          | undefined;
      ConfigID?: string | undefined;
      ConfigName?: string | undefined;
  }
1403
  interface SecretReference {
      File?:
          | {
              Name?: string | undefined;
              UID?: string | undefined;
              GID?: string | undefined;
              Mode?: number | undefined;
          }
          | undefined;
      SecretID?: string | undefined;
      SecretName?: string | undefined;
  }
1416
  interface Ulimit {
      Name?: string | undefined;
      Hard?: number | undefined;
      Soft?: number | undefined;
  }
1422
  interface ContainerSpec {
      Image?: string | undefined;
      Labels?: { [label: string]: string } | undefined;
      Command?: string[] | undefined;
      Args?: string[] | undefined;
      Hostname?: string | undefined;
      Env?: string[] | undefined;
      Dir?: string | undefined;
      User?: string | undefined;
      Groups?: string[] | undefined;
      Privileges?: Privileges | undefined;
      Init?: boolean | undefined;
      TTY?: boolean | undefined;
      OpenStdin?: boolean | undefined;
      ReadOnly?: boolean | undefined;
      Mounts?: MountSettings[] | undefined;
      StopSignal?: string | undefined;
      StopGracePeriod?: number | undefined;
      HealthCheck?: HealthConfig | undefined;
      Hosts?: string[] | undefined;
      DNSConfig?: DNSConfig | undefined;
      Configs?: ConfigReference[] | undefined;
      Secrets?: SecretReference[] | undefined;
      Isolation?: string | undefined;
      Sysctls?: { [key: string]: string } | undefined;
      CapabilityAdd?: string[] | undefined;
      CapabilityDrop?: string[] | undefined;
      Ulimits?: Ulimit[] | undefined;
  }
1452
  interface PluginSpec {
      Name?: string | undefined;
      Remote?: string | undefined;
      Privileges?:
          | {
              Name?: string | undefined;
              Description?: string | undefined;
              Value?: string[] | undefined;
          }
          | undefined;
      Disabled?: boolean | undefined;
      Env?: string[] | undefined;
  }
1466
  interface TaskSpecBase {
      Resources?: ResourceRequirements | undefined;
      RestartPolicy?: TaskRestartPolicy | undefined;
      Placement?: Placement | undefined;
      Networks?: NetworkAttachmentConfig[] | undefined;
      LogDriver?:
          | {
              Name?: string | undefined;
              Options?: { [key: string]: string } | undefined;
          }
          | undefined;
      ForceUpdate?: number | undefined;
      Runtime?: string | undefined;
  }
1481
  interface ContainerTaskSpec extends TaskSpecBase {
      ContainerSpec?: ContainerSpec | undefined;
  }
1485
  interface PluginTaskSpec extends TaskSpecBase {
      Runtime: "plugin";
      PluginSpec: PluginSpec;
  }
1490
  interface NetworkAttachmentTaskSpec extends TaskSpecBase {
      Runtime: "attachment";
      NetworkAttachmentSpec: {
          ContainerID: string;
      };
  }
1497
  type TaskSpec = ContainerTaskSpec | PluginTaskSpec | NetworkAttachmentTaskSpec;
1499
  interface ServiceMode {
      Replicated?: { Replicas?: number | undefined } | undefined;
      Global?: {} | undefined;
      ReplicatedJob?:
          | {
              MaxConcurrent?: number | undefined;
              TotalCompletions?: number | undefined;
          }
          | undefined;
      GlobalJob?: {} | undefined;
  }
1511
  interface UpdateConfig {
      Parallelism: number;
      Delay?: number | undefined;
      FailureAction?: string | undefined;
      Monitor?: number | undefined;
      MaxFailureRatio?: number | undefined;
      Order: string;
  }
1520
  interface PortConfig {
      Name?: string | undefined;
      Protocol?: "tcp" | "udp" | "sctp" | undefined;
      TargetPort?: number | undefined;
      PublishedPort?: number | undefined;
      PublishMode?: "ingress" | "host" | undefined;
  }
1528
  interface EndpointSpec {
      Mode?: string | undefined;
      Ports?: PortConfig[] | undefined;
  }
1533
  interface EndpointVirtualIP {
      NetworkID?: string | undefined;
      Addr?: string | undefined;
  }
1538
  interface Endpoint {
      Spec?: EndpointSpec | undefined;
      Ports?: PortConfig[] | undefined;
      VirtualIPs?: EndpointVirtualIP[] | undefined;
  }
1544
  interface ServiceSpec extends Annotations {
      TaskTemplate?: TaskSpec | undefined;
      Mode?: ServiceMode | undefined;
      UpdateConfig?: UpdateConfig | undefined;
      RollbackConfig?: UpdateConfig | undefined;
      Networks?: NetworkAttachmentConfig[] | undefined;
      EndpointSpec?: EndpointSpec | undefined;
  }
1553
  interface CreateServiceOptions extends ServiceSpec {
      authconfig?: AuthConfig | undefined;
      abortSignal?: AbortSignal;
  }
1558
  interface ContainerListOptions {
      abortSignal?: AbortSignal;
      /**
       * Return all containers. By default, only running containers are shown
       * @default false
       */
      all?: boolean;
      /**
       * Return this number of most recently created containers, including non-running ones.
       */
      limit?: number;
      /**
       * Return the size of container as fields `SizeRw` and `SizeRootFs`.
       * @default false
       */
      size?: boolean;
      /**
       * Filters to process on the container list, encoded as JSON (a map[string][]string).
       * A dictionary of key/value list is also accepted.
       */
      filters?: string | { [key: string]: string[] };
  }
1581
  interface ServiceListOptions {
      filters?:
          | {
              id?: string[] | undefined;
              label?: string[] | undefined;
              mode?: Array<"replicated" | "global"> | undefined;
              name?: string[] | undefined;
          }
          | string
          | undefined;
      status?: boolean | undefined;
      abortSignal?: AbortSignal;
  }
1595
  interface Version {
      Index?: number | undefined;
  }
1599
  interface Meta {
      Version?: Version | undefined;
      CreatedAt?: string | undefined;
      UpdatedAt?: string | undefined;
  }
1605
  type UpdateState =
      | "updating"
      | "paused"
      | "completed"
      | "rollback_started"
      | "rollback_paused"
      | "rollback_completed";
1613
  interface UpdateStatus {
      State?: UpdateState | undefined;
      StartedAt?: string | undefined;
      CompletedAt?: string | undefined;
      Message?: string | undefined;
  }
1620
  interface ServiceStatus {
      RunningTasks: number;
      DesiredTasks: number;
      CompletedTasks: number;
  }
1626
  interface JobStatus {
      JobIteration: Version;
      LastExecution?: string | undefined;
  }
1631
  interface Service extends Meta {
      ID: string;
      Spec?: ServiceSpec | undefined;
      PreviousSpec?: ServiceSpec | undefined;
      Endpoint?: Endpoint | undefined;
      UpdateStatus?: UpdateStatus | undefined;
      ServiceStatus?: ServiceStatus | undefined;
      JobStatus?: JobStatus | undefined;
  }
1641
  interface OrchestrationConfig {
      TaskHistoryRetentionLimit?: number | undefined;
  }
1645
  interface RaftConfig {
      SnapshotInterval?: number | undefined;
      KeepOldSnapshots?: number | undefined;
      LogEntriesForSlowFollowers?: number | undefined;
      ElectionTick?: number | undefined;
      HeartbeatTick?: number | undefined;
  }
1653
  interface DispatcherConfig {
      HeartbeatPeriod?: Duration | undefined;
  }
1657
  type ExternalCAProtocol = "cfssl" | string;
1659
  interface ExternalCA {
      Protocol: ExternalCAProtocol;
      URL: string;
      Options?: { [key: string]: string } | undefined;
      CACert: string;
  }
1666
  interface CAConfig {
      NodeCertExpiry?: Duration | undefined;
      ExternalCAs?: ExternalCA[] | undefined;
      SigningCACert?: string | undefined;
      SigningCAKey?: string | undefined;
      ForceRotate?: number | undefined;
  }
1674
  interface TaskDefaults {
      LogDriver?: Driver | undefined;
  }
1678
  interface EncryptionConfig {
      AutoLockManagers: boolean;
  }
1682
  interface Spec extends Annotations {
      Orchestration?: OrchestrationConfig | undefined;
      Raft: RaftConfig;
      Dispatcher?: DispatcherConfig | undefined;
      CAConfig?: CAConfig | undefined;
      TaskDefaults?: TaskDefaults | undefined;
      EncryptionConfig?: EncryptionConfig | undefined;
  }
1691
  interface TLSInfo {
      TrustRoot?: string | undefined;
      CertIssuerSubject?: string | undefined;
      CertIssuerPublicKey?: string | undefined;
  }
1697
  interface ClusterInfo extends Meta {
      ID: string;
      Spec: Spec;
      TLSInfo: TLSInfo;
      RootRotationInProgress: boolean;
      DefaultAddrPool: string[];
      SubnetSize: number;
      DataPathPort: number;
  }
1707
  interface JoinTokens {
      Worker: string;
      Manager: string;
  }
1712
  interface Swarm extends ClusterInfo {
      JoinTokens: JoinTokens;
  }
1716
  interface Driver {
      Name: string;
      Options?: { [key: string]: string } | undefined;
  }
1721
  interface SecretSpec extends Annotations {
      Data?: string | undefined;
      Driver?: Driver | undefined;
      Templating?: Driver | undefined;
  }
1727
  interface Secret extends Meta {
      ID: string;
      Spec?: SecretSpec | undefined;
  }
1732
  interface ConfigInfo {
      ID: string;
      Version: SecretVersion;
      CreatedAt: string;
      UpdatedAt?: string | undefined;
      Spec?: ConfigSpec | undefined;
  }
1740
  interface ConfigSpec {
      Name: string;
      Labels: { [label: string]: string };
      Data: string;
  }
1746
  interface ConfigVersion {
      Index: number;
  }
1750
  interface PluginInfo {
      Id?: string | undefined;
      Name: string;
      Enabled: boolean;
      Settings: PluginSettings;
      PluginReference?: string | undefined;
      Config: PluginConfig;
  }
1759
  type PluginInspectInfo = PluginInfo;
1761
  interface PluginSettings {
      Mounts: PluginMount[];
      Env: string[];
      Args: string[];
      Devices: PluginDevice[];
  }
1768
  interface PluginConfig {
      Description: string;
      Documentation: string;
      Interface: any;
      Entrypoint: string[];
      WorkDir: string;
      User?: User | undefined;
      Network: Network;
      Linux: Linux;
      PropagatedMount: string;
      Mounts: PluginMount[];
      Env: PluginEnv[];
      Args: Args;
      rootfs: any;
  }
1784
  interface Interface {
      Types: PluginInterfaceType[];
      Socket: string;
  }
1789
  interface PluginInterfaceType {
      Prefix: string;
      Capability: string;
      Version: string;
  }
1795
  interface PluginMount {
      Name: string;
      Description: string;
      Settable: string[];
      Source: string;
      Destination: string;
      Type: string;
      Options: string[];
  }
1805
  interface Linux {
      Capabilities: string[];
      AllowAllDevices: boolean;
      Devices: PluginDevice[];
  }
1811
  interface PluginDevice {
      Name: string;
      Description: string;
      Settable: string[];
      Path: string;
  }
1818
  interface Network {
      Type: string;
  }
1822
  interface PluginEnv {
      Name: string;
      Description: string;
      Settable: string[];
      Value: string;
  }
1829
  interface Args {
      Name: string;
      Description: string;
      Settable: string[];
      Value: string;
  }
1836
  interface User {
      UID: number;
      GID: number;
  }
1841
  interface ListImagesOptions {
      all?: boolean | undefined;
      filters?: string | { [key: string]: string[] } | undefined;
      digests?: boolean | undefined;
      abortSignal?: AbortSignal;
  }
1848
  interface ImageDistributionPlatformInfo {
      architecture: string;
      os: string;
      "os.version": string;
      "os.features": string[];
      variant: string;
  }
1856
  interface ImageDistributionDescriptorInfo {
      mediaType: string;
      digest: string;
      size: number;
  }
1862
  interface ImageDistributionInfo {
      Descriptor: ImageDistributionDescriptorInfo;
      Platforms: ImageDistributionPlatformInfo[];
  }
1867
  interface ImageRemoveInfo {
      Untagged: string;
      Deleted: string;
  }
1872
  interface ImageRemoveOptions {
      force?: boolean | undefined;
      noprune?: boolean | undefined;
      abortSignal?: AbortSignal;
  }
1878
  interface PruneImagesInfo {
      ImagesDeleted: ImageRemoveInfo[];
      SpaceReclaimed: number;
  }
1883
  interface PruneVolumesInfo {
      VolumesDeleted: string[];
      SpaceReclaimed: number;
  }
1888
  interface PruneContainersInfo {
      ContainersDeleted: string[];
      SpaceReclaimed: number;
  }
1893
  interface PruneNetworksInfo {
      NetworksDeleted: string[];
  }
1897
  interface ContainerWaitOptions {
      /** Since v1.30 */
      condition?: "not-running" | "next-exit" | "removed" | undefined;
      abortSignal?: AbortSignal;
  }
1903
  interface ContainerLogsOptions {
      stdout?: boolean | undefined;
      stderr?: boolean | undefined;
      follow?: boolean | undefined;
      since?: number | string | undefined;
      until?: number | string | undefined;
      details?: boolean | undefined;
      tail?: number | undefined;
      timestamps?: boolean | undefined;
      abortSignal?: AbortSignal;
  }
1915
  interface ContainerAttachOptions {
      detachKeys?: string | undefined;
      hijack?: boolean | undefined;
      logs?: boolean | undefined;
      stream?: boolean | undefined;
      stdin?: boolean | undefined;
      stdout?: boolean | undefined;
      stderr?: boolean | undefined;
      abortSignal?: AbortSignal;
  }
1926
  interface ContainerStopOptions {
      signal?: string;
      /** Number of seconds to wait before killing the container */
      t?: number;
      abortSignal?: AbortSignal;
  }
1933
  interface ImageBuildContext {
      context: string;
      src: string[];
  }
1938
  interface DockerVersion {
      ApiVersion: string;
      Arch: string;
      BuildTime: Date;
      Components: Array<{
          Details: {
              ApiVersion: string;
              Arch: string;
              BuildTime: Date;
              Experimental: string;
              GitCommit: string;
              GoVersion: string;
              KernelVersion: string;
              Os: string;
          };
          Name: string;
          Version: string;
      }>;
      GitCommit: string;
      GoVersion: string;
      KernelVersion: string;
      MinAPIVersion: string;
      Os: string;
      Platform: {
          Name: string;
      };
      Version: string;
  }
1967}
1968
1969type Callback<T> = (error?: any, result?: T) => void;
1970
1971declare class Dockerode {
  constructor(options?: Dockerode.DockerOptions);
1973
  createContainer(options: Dockerode.ContainerCreateOptions, callback: Callback<Dockerode.Container>): void;
  createContainer(options: Dockerode.ContainerCreateOptions): Promise<Dockerode.Container>;
1976
  createImage(options: {}, callback: Callback<NodeJS.ReadableStream>): void;
  createImage(auth: any, options: {}, callback: Callback<NodeJS.ReadableStream>): void;
  createImage(options: {}): Promise<NodeJS.ReadableStream>;
  createImage(auth: any, options: {}): Promise<NodeJS.ReadableStream>;
1981
  loadImage(file: string | NodeJS.ReadableStream, options: {}, callback: Callback<NodeJS.ReadableStream>): void;
  loadImage(file: string | NodeJS.ReadableStream, callback: Callback<NodeJS.ReadableStream>): void;
  loadImage(file: string | NodeJS.ReadableStream, options?: {}): Promise<NodeJS.ReadableStream>;
1985
  importImage(file: string | NodeJS.ReadableStream, options: {}, callback: Callback<NodeJS.ReadableStream>): void;
  importImage(file: string | NodeJS.ReadableStream, callback: Callback<NodeJS.ReadableStream>): void;
  importImage(file: string | NodeJS.ReadableStream, options?: {}): Promise<NodeJS.ReadableStream>;
1989
  checkAuth(options: any, callback: Callback<any>): void;
  checkAuth(options: any): Promise<any>;
1992
  buildImage(
      file: string | NodeJS.ReadableStream | Dockerode.ImageBuildContext,
      options: Dockerode.ImageBuildOptions,
      callback: Callback<NodeJS.ReadableStream>,
  ): void;
  buildImage(
      file: string | NodeJS.ReadableStream | Dockerode.ImageBuildContext,
      callback: Callback<NodeJS.ReadableStream>,
  ): void;
  buildImage(
      file: string | NodeJS.ReadableStream | Dockerode.ImageBuildContext,
      options?: Dockerode.ImageBuildOptions,
  ): Promise<NodeJS.ReadableStream>;
2006
  getContainer(id: string): Dockerode.Container;
2008
  getImage(name: string): Dockerode.Image;
2010
  getVolume(name: string): Dockerode.Volume;
2012
  getPlugin(name: string, remote: any): Dockerode.Plugin;
2014
  getService(id: string): Dockerode.Service;
2016
  getTask(id: string): Dockerode.Task;
2018
  getNode(id: string): Dockerode.Node;
2020
  getNetwork(id: string): Dockerode.Network;
2022
  getSecret(id: string): Dockerode.Secret;
2024
  getExec(id: string): Dockerode.Exec;
2026
  getConfig(id: string): Dockerode.Config;
2028
  listContainers(options: Dockerode.ContainerListOptions, callback: Callback<Dockerode.ContainerInfo[]>): void;
  listContainers(callback: Callback<Dockerode.ContainerInfo[]>): void;
  listContainers(options?: Dockerode.ContainerListOptions): Promise<Dockerode.ContainerInfo[]>;
2032
  listImages(options: Dockerode.ListImagesOptions, callback: Callback<Dockerode.ImageInfo[]>): void;
  listImages(callback: Callback<Dockerode.ImageInfo[]>): void;
  listImages(options?: Dockerode.ListImagesOptions): Promise<Dockerode.ImageInfo[]>;
2036
  listServices(options: Dockerode.ServiceListOptions, callback: Callback<Dockerode.Service[]>): void;
  listServices(callback: Callback<Dockerode.Service[]>): void;
  listServices(options?: Dockerode.ServiceListOptions): Promise<Dockerode.Service[]>;
2040
  listNodes(options: Dockerode.NodeListOptions, callback: Callback<any[]>): void;
  listNodes(callback: Callback<any[]>): void;
  listNodes(options?: Dockerode.NodeListOptions): Promise<any[]>;
2044
  listTasks(options: {}, callback: Callback<any[]>): void;
  listTasks(callback: Callback<any[]>): void;
  listTasks(options?: {}): Promise<any[]>;
2048
  listSecrets(options: {}, callback: Callback<Dockerode.Secret[]>): void;
  listSecrets(callback: Callback<Dockerode.Secret[]>): void;
  listSecrets(options?: {}): Promise<Dockerode.Secret[]>;
2052
  listPlugins(options: {}, callback: Callback<Dockerode.PluginInfo[]>): void;
  listPlugins(callback: Callback<Dockerode.PluginInfo[]>): void;
  listPlugins(options?: {}): Promise<Dockerode.PluginInfo[]>;
2056
  listVolumes(
      options: Dockerode.VolumeListOptions,
      callback: Callback<{
          Volumes: Dockerode.VolumeInspectInfo[];
          Warnings: string[];
      }>,
  ): void;
  listVolumes(
      callback: Callback<{
          Volumes: Dockerode.VolumeInspectInfo[];
          Warnings: string[];
      }>,
  ): void;
  listVolumes(options?: Dockerode.VolumeListOptions): Promise<{
      Volumes: Dockerode.VolumeInspectInfo[];
      Warnings: string[];
  }>;
2074
  listNetworks(options: Dockerode.NetworkListOptions, callback: Callback<Dockerode.NetworkInspectInfo[]>): void;
  listNetworks(callback: Callback<Dockerode.NetworkInspectInfo[]>): void;
  listNetworks(options?: Dockerode.NetworkListOptions): Promise<Dockerode.NetworkInspectInfo[]>;
2078
  listConfigs(options: {}, callback: Callback<Dockerode.ConfigInfo[]>): void;
  listConfigs(callback: Callback<Dockerode.ConfigInfo[]>): void;
  listConfigs(options?: {}): Promise<Dockerode.ConfigInfo[]>;
2082
  createSecret(options: {}, callback: Callback<any>): void;
  createSecret(options: {}): Promise<any>;
2085
  createConfig(options: {}, callback: Callback<any>): void;
  createConfig(options: {}): Promise<any>;
2088
  createPlugin(options: {}, callback: Callback<any>): void;
  createPlugin(options: {}): Promise<any>;
2091
  createVolume(options: Dockerode.VolumeCreateOptions, callback: Callback<Dockerode.Volume>): void;
  createVolume(callback: Callback<Dockerode.Volume>): void;
  createVolume(options?: Dockerode.VolumeCreateOptions): Promise<Dockerode.VolumeCreateResponse>;
2095
  createService(options: Dockerode.CreateServiceOptions, callback: Callback<Dockerode.Service>): void;
  createService(options: Dockerode.CreateServiceOptions): Promise<Dockerode.Service>;
  createService(auth: Dockerode.AuthConfig, options: Dockerode.ServiceSpec): Promise<Dockerode.Service>;
2099
  createNetwork(options: Dockerode.NetworkCreateOptions, callback: Callback<Dockerode.Network>): void;
  createNetwork(options: Dockerode.NetworkCreateOptions): Promise<Dockerode.Network>;
2102
  searchImages(options: {}, callback: Callback<any>): void;
  searchImages(options: {}): Promise<any>;
2105
  pruneImages(options: {}, callback: Callback<Dockerode.PruneImagesInfo>): void;
  pruneImages(callback: Callback<Dockerode.PruneImagesInfo>): void;
  pruneImages(options?: {}): Promise<Dockerode.PruneImagesInfo>;
2109
  pruneContainers(options: {}, callback: Callback<Dockerode.PruneContainersInfo>): void;
  pruneContainers(callback: Callback<Dockerode.PruneContainersInfo>): void;
  pruneContainers(options?: {}): Promise<Dockerode.PruneContainersInfo>;
2113
  pruneVolumes(options: Dockerode.VolumePruneOptions, callback: Callback<Dockerode.PruneVolumesInfo>): void;
  pruneVolumes(callback: Callback<Dockerode.PruneVolumesInfo>): void;
  pruneVolumes(options?: Dockerode.VolumePruneOptions): Promise<Dockerode.PruneVolumesInfo>;
2117
  pruneNetworks(options: {}, callback: Callback<Dockerode.PruneNetworksInfo>): void;
  pruneNetworks(callback: Callback<Dockerode.PruneNetworksInfo>): void;
  pruneNetworks(options?: {}): Promise<Dockerode.PruneNetworksInfo>;
2121
  info(callback: Callback<any>): void;
  info(): Promise<any>;
2124
  df(callback: Callback<any>): void;
  df(): Promise<any>;
2127
  version(callback: Callback<Dockerode.DockerVersion>): void;
  version(): Promise<Dockerode.DockerVersion>;
2130
  ping(callback: Callback<any>): void;
  ping(): Promise<any>;
2133
  getEvents(options: Dockerode.GetEventsOptions, callback: Callback<NodeJS.ReadableStream>): void;
  getEvents(callback: Callback<NodeJS.ReadableStream>): void;
  getEvents(options?: Dockerode.GetEventsOptions): Promise<NodeJS.ReadableStream>;
2137
  pull(repoTag: string, options: {}, callback: Callback<NodeJS.ReadableStream>, auth?: {}): Dockerode.Image;
  pull(repoTag: string, options?: {}): Promise<NodeJS.ReadableStream>;
2140
  run(
      image: string,
      cmd: string[],
      outputStream: NodeJS.WritableStream | NodeJS.WritableStream[],
      createOptions: Dockerode.ContainerCreateOptions,
      startOptions: Dockerode.ContainerStartOptions,
      callback: Callback<any>,
  ): events.EventEmitter;
  run(
      image: string,
      cmd: string[],
      outputStream: NodeJS.WritableStream | NodeJS.WritableStream[],
      createOptions: Dockerode.ContainerCreateOptions,
      callback: Callback<any>,
  ): events.EventEmitter;
  run(
      image: string,
      cmd: string[],
      outputStream: NodeJS.WritableStream | NodeJS.WritableStream[],
      callback: Callback<any>,
  ): events.EventEmitter;
  run(
      image: string,
      cmd: string[],
      outputStream: NodeJS.WritableStream | NodeJS.WritableStream[],
      createOptions?: Dockerode.ContainerCreateOptions,
      startOptions?: Dockerode.ContainerStartOptions,
  ): Promise<any>;
2169
  swarmInit(options: {}, callback: Callback<any>): void;
  swarmInit(options: {}): Promise<any>;
2172
  swarmJoin(options: {}, callback: Callback<any>): void;
  swarmJoin(options: {}): Promise<any>;
2175
  swarmLeave(options: {}, callback: Callback<any>): void;
  swarmLeave(options: {}): Promise<any>;
2178
  swarmUpdate(options: {}, callback: Callback<any>): void;
  swarmUpdate(options: {}): Promise<any>;
2181
  swarmInspect(callback: Callback<any>): void;
  swarmInspect(): Promise<any>;
2184
  modem: DockerModem;
2186}
2187
2188export = Dockerode;
1	`/// <reference types="node" />`
2
3	`import * as DockerModem from "docker-modem";`
4	`import * as events from "events";`
5	`import { ConnectConfig } from "ssh2";`
6	`import * as stream from "stream";`
7
8	`declare namespace Dockerode {`
9	`class Container {`
10	`constructor(modem: any, id: string);`
11
12	`modem: any;`
13	`id: string;`
14
15	`inspect(options: ContainerInspectOptions, callback: Callback<ContainerInspectInfo>): void;`
16	`inspect(callback: Callback<ContainerInspectInfo>): void;`
17	`inspect(options?: ContainerInspectOptions): Promise<ContainerInspectInfo>;`
18
19	`rename(options: {}, callback: Callback<any>): void;`
20	`rename(options: {}): Promise<any>;`
21
22	`update(options: {}, callback: Callback<any>): void;`
23	`update(options: {}): Promise<any>;`
24
25	`top(options: {}, callback: Callback<any>): void;`
26	`top(callback: Callback<any>): void;`
27	`top(options?: {}): Promise<any>;`
28
29	`changes(options: {}, callback: Callback<any>): void;`
30	`changes(callback: Callback<any>): void;`
31	`changes(options?: {}): Promise<any>;`
32
33	`export(options: {}, callback: Callback<NodeJS.ReadableStream>): void;`
34	`export(callback: Callback<NodeJS.ReadableStream>): void;`
35	`export(options?: {}): Promise<NodeJS.ReadableStream>;`
36
37	`start(options: ContainerStartOptions, callback: Callback<any>): void;`
38	`start(callback: Callback<any>): void;`
39	`start(options?: ContainerStartOptions): Promise<any>;`
40