From 40df226755d82863ff2a51789cd3a9167641cd32 Mon Sep 17 00:00:00 2001 From: Steven Date: Thu, 1 Nov 2018 11:37:15 -0400 Subject: [PATCH 1/4] Create types.d.ts --- types.d.ts | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 types.d.ts diff --git a/types.d.ts b/types.d.ts new file mode 100644 index 0000000..b8a6e09 --- /dev/null +++ b/types.d.ts @@ -0,0 +1,30 @@ +declare module 'docker-remote-api' { + interface InitOptions { + host: string; + } + + interface GetOptions { + qs?: {[name:string]: string},// set querystring parameters + headers?: {[name:string]: string},// set request headers + json?: boolean, // return json instead of a stream + buffer?: boolean, // return a buffer instead of a stream + drain?: boolean, // will drain the response stream before calling cb + timeout?: number, // set request timeout + version: string // set explicit api version "v1.14" (required) + } + + interface PostOptions extends GetOptions { + body: string | null; // set to NULL if there is no body json + } + + class DockerRequest { + get(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void; + delete(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void; + head(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void; + post(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void; + put(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void; + } + + function DockerInit(opt: InitOptions): DockerRequest; + export = DockerInit; +} From 8d376a115ce06b2fb743171003a72b82f4e3f776 Mon Sep 17 00:00:00 2001 From: Steven Date: Thu, 1 Nov 2018 11:38:02 -0400 Subject: [PATCH 2/4] Add types to package.json --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index b00cd56..74470c5 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,7 @@ "description": "Basic http wrapper to call the docker remote api from node", "version": "5.0.0", "main": "index.js", + "types": "types.d.ts", "dependencies": { "concat-stream": "^1.4.6", "docker-host": "^3.0.0", From 0483d2114e2d75388c1e5ec8f7ab30536a3ed6ce Mon Sep 17 00:00:00 2001 From: Steven Date: Thu, 1 Nov 2018 11:41:27 -0400 Subject: [PATCH 3/4] Add ts usage to readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 290617c..170f028 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,18 @@ request.get('/images/json', function(err, stream) { }) ``` +### TypeScript + +Change `var` to `import` in order to tell typescript to use the declarations like so: + +``` ts +import docker = require('docker-remote-api') +var request = docker({ + host: '/var/run/docker.sock' +}) +``` + + ## API #### `request = docker(options)` From 88270282f6b36643147d3501acd819ffc472736b Mon Sep 17 00:00:00 2001 From: Steven Date: Tue, 13 Nov 2018 15:03:16 -0500 Subject: [PATCH 4/4] Fix whitespace --- types.d.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/types.d.ts b/types.d.ts index b8a6e09..8d9264c 100644 --- a/types.d.ts +++ b/types.d.ts @@ -4,13 +4,13 @@ declare module 'docker-remote-api' { } interface GetOptions { - qs?: {[name:string]: string},// set querystring parameters - headers?: {[name:string]: string},// set request headers - json?: boolean, // return json instead of a stream - buffer?: boolean, // return a buffer instead of a stream - drain?: boolean, // will drain the response stream before calling cb - timeout?: number, // set request timeout - version: string // set explicit api version "v1.14" (required) + qs?: { [name: string]: string }; // set querystring parameters + headers?: { [name: string]: string }; // set request headers + json?: boolean; // return json instead of a stream + buffer?: boolean; // return a buffer instead of a stream + drain?: boolean; // will drain the response stream before calling cb + timeout?: number; // set request timeout + version: string; // set explicit api version "v1.14" (required) } interface PostOptions extends GetOptions { @@ -22,7 +22,7 @@ declare module 'docker-remote-api' { delete(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void; head(path: string, opt: GetOptions, fn: (err: Error, data: T) => void): void; post(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void; - put(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void; + put(path: string, opt: PostOptions, fn: (err: Error, data: T) => void): void; } function DockerInit(opt: InitOptions): DockerRequest;