From 8742a3dec1e546f44817d01416acaa6492efab64 Mon Sep 17 00:00:00 2001 From: Byeong Hun Yoo Date: Fri, 28 Jul 2017 00:02:58 +0900 Subject: [PATCH] Add missing parameter type to buildImage (#18436) https://github.com/apocas/dockerode#building-an-image3 --- types/dockerode/dockerode-tests.ts | 4 ++++ types/dockerode/index.d.ts | 15 +++++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/types/dockerode/dockerode-tests.ts b/types/dockerode/dockerode-tests.ts index ef2ed924d1..14ea3ca639 100644 --- a/types/dockerode/dockerode-tests.ts +++ b/types/dockerode/dockerode-tests.ts @@ -74,6 +74,10 @@ docker.buildImage('archive.tar', { t: 'imageName' }, (err, response) => { // NOOP }); +docker.buildImage({context: '.', src: ['Dockerfile', 'test.sh']}, { t: 'imageName' }, (err, response) => { + // NOOP +}); + docker.createContainer({ Tty: true }, (err, container) => { container.start((err, data) => { // NOOP diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index d6cbadf938..aa6c03bf29 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -1,6 +1,8 @@ // Type definitions for dockerode 2.4 // Project: https://github.com/apocas/dockerode -// Definitions by: Carl Winkler , Nicolas Laplante +// Definitions by: Carl Winkler +// Nicolas Laplante +// ByeongHun Yoo // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 @@ -804,6 +806,11 @@ declare namespace Dockerode { tail?: number; timestamps?: boolean; } + + interface ImageBuildContext { + context: string; + src: string[]; + } } type Callback = (error?: any, result?: T) => void; @@ -830,9 +837,9 @@ declare class Dockerode { checkAuth(options: any, callback: Callback): void; checkAuth(options: any): Promise; - buildImage(file: string | NodeJS.ReadableStream, options: {}, callback: Callback): void; - buildImage(file: string | NodeJS.ReadableStream, callback: Callback): void; - buildImage(file: string | NodeJS.ReadableStream, options?: {}): Promise; + buildImage(file: string | NodeJS.ReadableStream | Dockerode.ImageBuildContext, options: {}, callback: Callback): void; + buildImage(file: string | NodeJS.ReadableStream | Dockerode.ImageBuildContext, callback: Callback): void; + buildImage(file: string | NodeJS.ReadableStream | Dockerode.ImageBuildContext, options?: {}): Promise; getContainer(id: string): Dockerode.Container;