INSTRUCTIONS

Replace all occurences of _ADAPTER_NAME_ with the name of the adapter you will be connecting juttle to and this template should be a good starting point for developing your adapter.

Follow the Adapter Test Checklist to add testcases at unit and integration test levels to the new adapter.

Consult the Adapter Publishing Checklist for proper packaging guidelines.

Juttle ADAPTER_NAME Adapter

Examples

Reading

read _ADAPTER_NAME_ ...

Writing

... | write _ADAPTER_NAME_

Installation

Like Juttle itself, the adapter is installed as a npm package. Both Juttle and the adapter need to be installed side-by-side:

$ npm install juttle
$ npm install juttle-_ADAPTER_NAME_-adapter

Configuration

The adapter needs to be registered and configured so that it can be used from within Juttle. To do so, add the following to your ~/.juttle/config.json file:

{
    "adapters": {
        "_ADAPTER_NAME_": {
            <<XXX>>
        }
    }
}

Usage

Read options

When reading data out of ADAPTER_NAME ...

Name	Type	Required	Description
from	moment	no	select points after this time (inclusive)
to	moment	no	select points before this time (exclusive)

Write options

When writing data to ADAPTER_NAME ...

Name	Type	Required	Description
...	...	no	...

Contributing

Want to contribute? Awesome! Don't hesitate to file an issue or open a pull request.