dan/docker-compose
1
0
Fork 0
mirror of https://github.com/danbulant/docker-compose synced 2026-05-24 12:35:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #29 from lukeautry/lukeautry/typescript-type-declarations

Browse source 
typescript declarations
This commit is contained in:
Alexander Zeitler 2018-11-23 12:49:46 +01:00 committed by GitHub
commit fd10054383
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
index.d.ts vendored Normal file
View file

@ -0,0 +1,30 @@
declare module "docker-compose" {
interface IDockerCompose {
upAll(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
upMany(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
upOne(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
kill(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
down(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
stop(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
rm(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
exec(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
run(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
buildAll(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
buildMany(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
buildOne(options: IDockerComposeOptions): Promise<IDockerComposeResult>;
}
interface IDockerComposeOptions {
cwd: string;
config?: string | string[];
log?: boolean;
}
interface IDockerComposeResult {
out: string;
err: string;
}
const _: IDockerCompose;
export = _;
}

1
package.json
View file

@ -2,6 +2,7 @@
"name": "docker-compose", "name": "docker-compose",
"version": "0.9.1", "version": "0.9.1",
"main": "index.js", "main": "index.js",
"typings": "index.d.ts",
"scripts": { "scripts": {
"test": "./node_modules/.bin/tape test", "test": "./node_modules/.bin/tape test",
"eslint": "./node_modules/.bin/eslint ." "eslint": "./node_modules/.bin/eslint ."