kill

Force stop service containers.

Usage

import * as compose from 'docker-compose'
import * as path from 'path'

const result = await compose.kill({ cwd: path.join(__dirname) })

Parameters

Parameter	Type	Description
options	IDockerComposeOptions	Configuration options

Example

import * as compose from 'docker-compose'
import * as path from 'path'

compose.kill({ cwd: path.join(__dirname), log: true })
  .then(
    () => { console.log('Containers killed') },
    err => { console.log('something went wrong:', err.message) }
  )

Options

In addition to the common options, kill supports these command options:

• --signal / -s - Signal to send to the container (default: SIGKILL)

compose.kill({
  cwd: path.join(__dirname),
  commandOptions: [['--signal', 'SIGTERM']]
})