@terascope/docker-compose-js / Compose

Class: Compose

Constructors

new Compose()

new Compose(composeFile): Compose

Parameters

Parameter	Type
composeFile	string

Returns

Compose

Source

index.ts:14

Properties

composeFile

composeFile: string

Source

index.ts:13

Methods

build()

build(options?): Promise<string>

Parameters

Parameter	Type
options?	RunOptions

Returns

Promise<string>

Source

index.ts:113

---

create()

create(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:145

---

down()

down(options?): Promise<string>

Parameters

Parameter	Type
options?	RunOptions

Returns

Promise<string>

Source

index.ts:117

---

kill()

kill(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:137

---

pause()

pause(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:153

---

port()

port(service, privatePort, options?): Promise<string>

Parameters

Parameter	Type
service	string
privatePort	string | number
options?	RunOptions

Returns

Promise<string>

Source

index.ts:169

---

ps()

ps(options?): Promise<string>

Parameters

Parameter	Type
options?	RunOptions

Returns

Promise<string>

Source

index.ts:121

---

pull()

pull(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:141

---

restart()

restart(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:133

---

rm()

rm(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:165

---

runCmd()

runCmd(command, options?, services?, ...extraParams?): Promise<string>

Parameters

Parameter	Type
command	string
options?	RunOptions
services?	Services
...extraParams?	Arg[]

Returns

Promise<string>

Source

index.ts:18

---

scale()

scale(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:161

---

start()

start(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:125

---

stop()

stop(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:129

---

unpause()

unpause(services?, options?): Promise<string>

Parameters

Parameter	Type
services?	Services
options?	RunOptions

Returns

Promise<string>

Source

index.ts:157

---

up()

up(options, services?): Promise<string>

Parameters

Parameter	Type
options	RunOptions
services?	string | string[]

Returns

Promise<string>

Source

index.ts:108

---

version()

version(options?): Promise<string>

Parameters

Parameter	Type
options?	RunOptions

Returns

Promise<string>

Source

index.ts:149