Constructor
new Docker(machineName)
Parameters:
| Name | Type | Description |
|---|---|---|
machineName |
string | The name of the docker machine |
- Source:
Methods
containerExists(name) → {promise}
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the container |
- Source:
Returns:
Bluebird Promise
- Type
- promise
create(image, hostConfig, nameopt) → {promise}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
image |
string | ||
hostConfig |
object | ||
name |
string |
<optional> |
- Source:
Returns:
Bluebird Promise
- Type
- promise
createContainer(options) → {promise}
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object |
- Source:
Returns:
Bluebird Promise
- Type
- promise
getContainer(name) → {promise}
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the container |
- Source:
Returns:
Bluebird Promise
- Type
- promise
pull(repoTag) → {promise}
Pulls a docker repo
Parameters:
| Name | Type | Description |
|---|---|---|
repoTag |
string | The docker repo to pull |
- Source:
Returns:
Bluebird Promise
- Type
- promise
ready() → {promise}
Resolves when the docker instance is ready
- Source:
Returns:
Bluebird Promise
- Type
- promise
remove(name) → {promise}
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the container to remove |
- Source:
Returns:
Bluebird Promise
- Type
- promise
start(name) → {promise}
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the container |
- Source:
Returns:
Bluebird Promise
- Type
- promise
stop(name) → {promise}
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the container |
- Source:
Returns:
Bluebird Promise
- Type
- promise