dockerode-ts
TypeScript icon, indicating that this package has built-in type declarations

0.3.2 • Public • Published

dockerode-ts

Dockerode wrapped in TypeScript

Why?

The dockerode library is great and has quite a large API surface.
I found myself frequently referring to the source code of dockerode since the documentation is not complete.
This is an effort to statically type that API surface which is another form of documentation.

Where are the types?

You can view them here

Requirements

  • TypeScript (1.8+)
  • NodeJS

Installation

npm install dockerode-ts

Usage

import Dockerode from 'dockerode-ts';
 
const docker = new Dockerode({ /** options... */ });

TODOs

  • Most callbacks are typed as any. These should be typed correctly.

License

MIT

Package Sidebar

Install

npm i dockerode-ts

Weekly Downloads

1,473

Version

0.3.2

License

MIT

Last publish

Collaborators

  • seikho