@terascope/docker-compose-js / Compose
Class: Compose
Defined in: index.ts:12
Constructors
new Compose()
new Compose(
composeFile):Compose
Defined in: index.ts:14
Parameters
| Parameter | Type |
|---|---|
composeFile | string |
Returns
Properties
| Property | Type | Defined in |
|---|---|---|
composeFile | string | index.ts:13 |
Methods
build()
build(
options?):Promise<string>
Defined in: index.ts:116
Parameters
| Parameter | Type |
|---|---|
options? | RunOptions |
Returns
Promise<string>
create()
create(
services?,options?):Promise<string>
Defined in: index.ts:148
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
down()
down(
options?):Promise<string>
Defined in: index.ts:120
Parameters
| Parameter | Type |
|---|---|
options? | RunOptions |
Returns
Promise<string>
kill()
kill(
services?,options?):Promise<string>
Defined in: index.ts:140
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
pause()
pause(
services?,options?):Promise<string>
Defined in: index.ts:156
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
port()
port(
service,privatePort,options?):Promise<string>
Defined in: index.ts:172
Parameters
| Parameter | Type |
|---|---|
service | string |
privatePort | string | number |
options? | RunOptions |
Returns
Promise<string>
ps()
ps(
options?):Promise<string>
Defined in: index.ts:124
Parameters
| Parameter | Type |
|---|---|
options? | RunOptions |
Returns
Promise<string>
pull()
pull(
services?,options?):Promise<string>
Defined in: index.ts:144
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
restart()
restart(
services?,options?):Promise<string>
Defined in: index.ts:136
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
rm()
rm(
services?,options?):Promise<string>
Defined in: index.ts:168
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
runCmd()
runCmd(
command,options?,services?, ...extraParams?):Promise<string>
Defined in: index.ts:18
Parameters
| Parameter | Type |
|---|---|
command | string |
options? | RunOptions |
services? | Services |
...extraParams? | Arg[] |
Returns
Promise<string>
scale()
scale(
services?,options?):Promise<string>
Defined in: index.ts:164
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
start()
start(
services?,options?):Promise<string>
Defined in: index.ts:128
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
stop()
stop(
services?,options?):Promise<string>
Defined in: index.ts:132
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
unpause()
unpause(
services?,options?):Promise<string>
Defined in: index.ts:160
Parameters
| Parameter | Type |
|---|---|
services? | Services |
options? | RunOptions |
Returns
Promise<string>
up()
up(
options,services?):Promise<string>
Defined in: index.ts:111
Parameters
| Parameter | Type |
|---|---|
options | RunOptions |
services? | string | string[] |
Returns
Promise<string>
version()
version(
options?):Promise<string>
Defined in: index.ts:152
Parameters
| Parameter | Type |
|---|---|
options? | RunOptions |
Returns
Promise<string>