@types/dockerode - npm Package Compare versions

Comparing version 2.3.3 to 2.4.0

dockerode/index.d.ts

@@ -1,4 +0,4 @@
-// Type definitions for dockerode 2.3
+// Type definitions for dockerode 2.4
 // Project: https://github.com/apocas/dockerode
-// Definitions by: Carl Winkler <https://github.com/seikho>
+// Definitions by: Carl Winkler <https://github.com/seikho>, Nicolas Laplante <https://github.com/nlaplante>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -96,4 +96,4 @@
 
-    remove(options: {}, callback: Callback<any>): void;
-    remove(callback: Callback<any>): void;
+    remove(options: {}, callback: Callback<ImageRemoveInfo>): void;
+    remove(callback: Callback<ImageRemoveInfo>): void;
 
@@ -140,2 +140,45 @@ modem: any;
 
+  interface Plugin {
+    modem: any;
+    name: string;
+    remote: any;
+
+    inspect(callback: Callback<PluginInspectInfo>): void;
+
+    remove(options: {}, callback: Callback<any>): void;
+    remove(callback: Callback<any>): void;
+
+    privileges(callback: Callback<any>): void;
+
+    pull(options: {}, callback: Callback<any>): void;
+
+    enable(options: {}, callback: Callback<any>): void;
+    enable(callback: Callback<any>): void;
+
+    disable(options: {}, callback: Callback<any>): void;
+    disable(callback: Callback<any>): void;
+
+    push(options: {}, callback: Callback<any>): void;
+    push(callback: Callback<any>): void;
+
+    configure(options: {}, callback: Callback<any>): void;
+    configure(callback: Callback<any>): void;
+
+    upgrade(auth: any, options: {}, callback: Callback<any>): void;
+    upgrade(auth: any, callback: Callback<any>): void;
+  }
+
+  interface Secret {
+    inspect(callback: Callback<SecretInfo>): void;
+
+    update(options: {}, callback: Callback<any>): void;
+    update(callback: Callback<any>): void;
+
+    remove(options: {}, callback: Callback<any>): void;
+    remove(callback: Callback<any>): void;
+
+    modem: any;
+    id?: string;
+  }
+
   interface Network {
@@ -550,2 +593,133 @@ inspect(callback: Callback<any>): void;
   }
+
+  interface SecretVersion {
+    Index: number;
+  }
+
+  interface ServiceSpec {
+    Name: string;
+  }
+
+  interface SecretInfo {
+    ID: string;
+    Version: SecretVersion;
+    CreatedAt: string;
+    UpdatedAt?: string;
+    Spec?: ServiceSpec;
+  }
+
+  interface PluginInfo {
+    Id?: string;
+    Name: string;
+    Enabled: boolean;
+    Settings: PluginSettings;
+    PluginReference?: string;
+    Config: PluginConfig;
+  }
+
+  type PluginInspectInfo = PluginInfo;
+
+  interface PluginSettings {
+    Mounts: PluginMount[];
+    Env: string[];
+    Args: string[];
+    Devices: PluginDevice[];
+  }
+
+  interface PluginConfig {
+    Description: string;
+    Documentation: string;
+    Interface: any;
+    Entrypoint: string[];
+    WorkDir: string;
+    User?: User;
+    Network: Network;
+    Linux: Linux;
+    PropagatedMount: string;
+    Mounts: PluginMount[];
+    Env: PluginEnv[];
+    Args: Args;
+    rootfs: any;
+  }
+
+  interface Interface {
+    Types: PluginInterfaceType[];
+    Socket: string;
+  }
+
+  interface PluginInterfaceType {
+    Prefix: string;
+    Capability: string;
+    Version: string;
+  }
+
+  interface PluginMount {
+    Name: string;
+    Description: string;
+    Settable: string[];
+    Source: string;
+    Destination: string;
+    Type: string;
+    Options: string[];
+  }
+
+  interface Linux {
+    Capabilities: string[];
+    AllowAllDevices: boolean;
+    Devices: PluginDevice[];
+  }
+
+  interface PluginDevice {
+    Name: string;
+    Description: string;
+    Settable: string[];
+    Path: string;
+  }
+
+  interface Network {
+    Type: string;
+  }
+
+  interface PluginEnv {
+    Name: string;
+    Description: string;
+    Settable: string[];
+    Value: string;
+  }
+
+  interface Args {
+    Name: string;
+    Description: string;
+    Settable: string[];
+    Value: string;
+  }
+
+  interface User {
+    UID: number;
+    GID: number;
+  }
+
+  interface ImageRemoveInfo {
+    Untagged: string;
+    Deleted: string;
+  }
+
+  interface PruneImagesInfo {
+    ImagesDeleted: ImageRemoveInfo[];
+    SpaceReclaimed: number;
+  }
+
+  interface PruneVolumesInfo {
+    VolumesDeleted: string[];
+    SpaceReclaimed: number;
+  }
+
+  interface PruneContainersInfo {
+    ContainersDeleted: string[];
+    SpaceReclaimed: number;
+  }
+
+  interface PruneNetworksInfo {
+    NetworksDeleted: string[];
+  }
 }
@@ -580,2 +754,4 @@
 
+  getPlugin(name: string, remote: any): Dockerode.Plugin;
+
   getService(id: string): Dockerode.Service;
@@ -589,2 +765,4 @@
 
+  getSecret(id: string): Dockerode.Secret;
+
   getExec(id: string): Dockerode.Exec;
@@ -607,2 +785,8 @@
 
+  listSecrets(options: {}, callback: Callback<Dockerode.SecretInfo[]>): void;
+  listSecrets(callback: Callback<Dockerode.SecretInfo[]>): void;
+
+  listPlugins(options: {}, callback: Callback<Dockerode.PluginInfo[]>): void;
+  listPlugins(callback: Callback<Dockerode.PluginInfo[]>): void;
+
   listVolumes(options: {}, callback: Callback<any[]>): void;
@@ -614,2 +798,6 @@ listVolumes(callback: Callback<any[]>): void;
 
+  createSecret(options: {}, callback: Callback<any>): void;
+
+  createPlugin(options: {}, callback: Callback<any>): void;
+
   createVolume(options: {}, callback: Callback<any>): void;
@@ -623,2 +811,14 @@
 
+  pruneImages(options: {}, callback: Callback<Dockerode.PruneImagesInfo>): void;
+  pruneImages(callback: Callback<Dockerode.PruneImagesInfo>): void;
+
+  pruneContainers(options: {}, callback: Callback<Dockerode.PruneContainersInfo>): void;
+  pruneContainers(callback: Callback<Dockerode.PruneContainersInfo>): void;
+
+  pruneVolumes(options: {}, callback: Callback<Dockerode.PruneVolumesInfo>): void;
+  pruneVolumes(callback: Callback<Dockerode.PruneVolumesInfo>): void;
+
+  pruneNetworks(options: {}, callback: Callback<Dockerode.PruneNetworksInfo>): void;
+  pruneNetworks(callback: Callback<Dockerode.PruneNetworksInfo>): void;
+
   info(callback: Callback<any>): void;
@@ -648,2 +848,4 @@
 
+  swarmInspect(callback: Callback<any>): void;
+
   modem: any;
@@ -650,0 +852,0 @@ }

dockerode/package.json

 {
     "name": "@types/dockerode",
-    "version": "2.3.3",
+    "version": "2.4.0",
     "description": "TypeScript definitions for dockerode",
@@ -10,2 +10,6 @@ "license": "MIT",
             "url": "https://github.com/seikho"
+        },
+        {
+            "name": "Nicolas Laplante",
+            "url": "https://github.com/nlaplante"
         }
@@ -23,4 +27,4 @@ ],
     "peerDependencies": {},
-    "typesPublisherContentHash": "b874047eca700b301004cabb3bcecd21a6112bacbde4512cd35b6518a28c6708",
+    "typesPublisherContentHash": "95ec6b0677f4ce433130c04364b1b4a36c1872fc070d3497d5d46c4cc80eb66e",
     "typeScriptVersion": "2.0"
 }

dockerode/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Thu, 30 Mar 2017 22:36:49 GMT
+ * Last updated: Fri, 31 Mar 2017 16:02:24 GMT
  * Dependencies: stream, events, node
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Carl Winkler <https://github.com/seikho>.
+These definitions were written by Carl Winkler <https://github.com/seikho>, Nicolas Laplante <https://github.com/nlaplante>.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24168

increased by26.6%

Lines of code

697

increased by28.84%

No dependency changes