Slack ORM

Provides an Object Relationional Model for interfacing with the Slack API.

Usage

Add the Slack ORM NPM to your Node.js project:

npm install slack-orm --save

To call the Slack REST API directly, you can make use of the API adapter, which follows a Promise pattern:

var SlackORM = require('slack-orm'),
    
    slack = new SlackORM('my-token-from-slack'),
    
    params = {
        foo : 'bar'
    };

slack.api
    .call('api.test', params)
    .then(function(response) {
        console.log("Slack OK: ", response.ok ? "YES" : "NO");
        console.log("Foo: ", response.args.foo);
    })
    .catch(function(err) {
        console.warn("Slack Error: ", err);
    });

Contributing

There are many ways to contribute to the Slack ORM module! If you have an idea, or have discovered a bug, please Open an Issue so it can be addressed.

If you're interested in contributing to the project through design or development, please read our Contribution Guidelines.

Release Policy

Releases of the Slack ORM module follow Semantic Versioning standards in a MAJOR.MINOR.PATCH versioning scheme of the following format:

• MAJOR - modified when major, incompatible changes are made to the library,
• MINOR - modified when functionality is added in a backwards-compatible mannder, and
• PATCH - patches to existing functionality, such as documentation and bug fixes.

License

Copyright © 2015 Andrew Vaughan - Released under the MIT license.