Mergent JavaScript Library

The Mergent JavaScript library provides convenient access to the Mergent API from applications written in the JavaScript language.

Installation

Install the package with:

npm install mergent --save
# or
yarn add mergent

Usage

The library needs to be configured with your project's API key. Set Mergent.api_key to its value:

const Mergent = require("mergent");

// set the Mergent API key
const mergent = new Mergent("...");

// create a Task that will make an HTTP request in 5 minutes
mergent.tasks
  .create({
    request: { url: "...", body: "Hello, world!" },
    delay: { minutes: 5 },
  })
  .then((task) => console.log(task))
  .catch((error) => console.error(error));

// create a recurring Schedule that will make an HTTP request every minute
mergent.schedules
  .create({
    request: { url: "...", body: "Hello, world!" },
    cron: "* * * * *",
  })
  .then((task) => console.log(task))
  .catch((error) => console.error(error));

Usage with TypeScript

import Mergent from "mergent";

// set the Mergent API key
const mergent = new Mergent("...");

// create a Task that will make an HTTP request in 5 minutes
mergent.tasks
  .create({
    request: { url: "...", body: "Hello, world!" },
    delay: { minutes: 5 },
  })
  .then((task) => console.log(task))
  .catch((error) => console.error(error));

// create a recurring Schedule that will make an HTTP request every minute
mergent.schedules
  .create({
    request: { url: "...", body: "Hello, world!" },
    cron: "* * * * *",
  })
  .then((task) => console.log(task))
  .catch((error) => console.error(error));

See the Mergent JavaScript docs for more details.

Development

After checking out the repo, run npm install to install dependencies. Then, run npm test to run the tests.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mergentlabs/mergent-js.

Distributing

1. Update the version with npm version <version> (this makes a new commit)
2. Amend that commit with updates to the CHANGELOG
3. Push with git push --tags
4. Package with npm run package
5. Publish with npm publish

License

The library is available as open source under the terms of the MIT License.