sfowl/typescript

[EOL] see https://github.com/kubernetes-client/javascript instead

DEPRECATED!

This library has been deprecated and merged with the javascript library project.

Please file issues and PRs against that project, this is retained for historical reasons only.

typescript client for Kubernetes

Note: This is alpha software. It is under continuous improvement and is subject to change at any time.

This is the Typescript client library for Kubernetes. It's intended to be used in Node applications that want to talk to the Kubernetes API.

Installing

To install and save the result to your project's local package.json manifest:

npm install --save @kubernetes/typescript-node

Development

All dependencies of this project are expressed in its package.json file. Before you start developing, ensure that you have NPM installed, then run:

npm install

Testing

Tests are written using the Chai library. See config_test.ts for an example.

To run tests, execute the following:

npm test

Example Code

import config = require('./config');

let k8sApi = config.Config.defaultClient();

k8sApi.listNamespacedPod('default')
    .then((res) => {
        console.log(res.body);
    });