Skip to content
This repository has been archived by the owner on Nov 19, 2022. It is now read-only.
/ language-openfn Public archive

An (experimental) adaptor for working with the OpenFn.org web API

License

GPL-3.0, LGPL-3.0 licenses found

Licenses found

GPL-3.0
LICENSE
LGPL-3.0
LICENSE.LESSER
Notifications You must be signed in to change notification settings

OpenFn/language-openfn

Repository files navigation

⚠️ MOVED TO OpenFn/adaptors! ⚠️

N.B.: New versions are available at: https://github.com/OpenFn/adaptors/tree/main/packages/openfn

Language OpenFn (Archived) Build Status

Adaptor for building expressions and operations to interact with the OpenFn API.

Documentation

request

request({
  method: 'get',
  path: 'jobs',
  params: {
    project_id: 490,
  },
});
request(
  {
    method: 'post',
    path: 'jobs',
    data: {
      trigger_id: 1,
      expression: 'steps()',
    },
  },
  state => {
    console.log('cool callback!');
    return state;
  }
);

sample configuration

{
  "host": "https://www.openfn.org",
  "username": "someone@ngo.org",
  "password": "supersecret",
  "projectId": "ID"
}

Development

Clone the repo, run npm install.

Run tests using npm run test or npm run test:watch

Build the project using make.

To build the docs for this repo, run ./node_modules/.bin/jsdoc --readme ./README.md ./lib -d docs.

About

An (experimental) adaptor for working with the OpenFn.org web API

Resources

License

GPL-3.0, LGPL-3.0 licenses found

Licenses found

GPL-3.0
LICENSE
LGPL-3.0
LICENSE.LESSER

Stars

Watchers

Forks

Packages

No packages published