node-triton icon indicating copy to clipboard operation
node-triton copied to clipboard

Documentation for node_module usage

Open donniev opened this issue 9 years ago • 2 comments

Is there any documentation on methods available using as a node module. For instance (pun intended) is there a method equivalent to the the cli triton inst get xxx

donniev avatar Mar 08 '16 23:03 donniev

I think this is what you're looking for:

https://github.com/joyent/node-triton/blob/master/examples/example-list-instances.js

bahamat avatar Mar 09 '16 02:03 bahamat

@donniev You are right, there isn't much.

  • The starter: https://github.com/joyent/node-triton#tritonapi-module-usage
  • Some examples in the "examples/" dir as @bahamat points out.
  • The createClient block comment: https://github.com/joyent/node-triton/blob/7d635fc81c075bce76d66a37017f847921de623c/lib/index.js#L18-L94

And then it is pretty much: read the "lib/tritonapi.js" and "lib/cloudapi2.js" code.

We should write reference docs. Let's use this ticket to at least start them.

trentm avatar Mar 09 '16 17:03 trentm