README.md

Typed dockerode

Type definitions for dockerode.

Installation

Installation can be done using typings.

From the registry:

$ typings install dockerode --save

From the source:

$ typings install github:typed-contrib/dockerode --save

dockerode module works in node.js environment. So you also have to install node.js typings.

$ typings install env~node --global --save

Contributing

Contributions are welcome !

# Installation
# Fork this repo (https://github.com/typed-contrib/dockerode)
# Clone the fork (E.g. `https://github.com/<your_username>/dockerode.git`)
cd dockerode

# Install modules and dependencies
npm install

# Test typings over dockerode tests
npm test

Some resources to help writing Typescript type definitions:

• Writing Declaration Files
• typings examples

Tests

This type definitions are tested using source dockerode chai tests.

License

MIT