Package Exports

docker-remote-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docker-remote-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

docker-remote-api

Basic http wrapper to call the docker remote api from node

npm install docker-remote-api

Usage

var docker = require('docker-remote-api')
var request = docker('/var/run/docker.sock')

request.get('/images/json', {json:true}, function(err, images) {
  if (err) throw err
  console.log('images', images)
})

request.get('/images/json', function(err, stream) {
  if (err) throw err
  // stream is a raw response stream
})

API

`request = docker([remote], defaults)`

remote should be an address to a docker instance i.e. /var/run/docker.sock or 127.0.0.1:2375. defaults will be used as default values for get, post, put, delete.

If you omit the remote it will be set to $DOCKER_HOST

`request.get(path, [options], cb)`

Send a GET request to the remote api. path should be the request path i.e. /images/json. options can contain the following

{
  qs: {foo:'bar'},        // set querystring parameters
  headers: {name: '...'}, // set request headers
  json: true,             // return json instead of a stream
  timeout: 20000,         // set request timeout
  version: 'v1.12'        // set explicit api version
}

`request.delete(path, [options], cb)`

Send a DELETE request. Similar options as request.get

`post = request.post(path, [options], cb)`

Send a POST request. Similar options as request.get except it returns a request stream that you can pipe a request body to. If you are sending json you can set options.json = body and body will be stringified and sent as the request body.

`put = request.put(path, [options], cb)`

Send a PUT request. Similar options as request.put

License

MIT