README

slack-users

Get the users of a slack community.

Install

Install with npm:

$ npm install --save slack-users

Usage

var slackUsers = require('slack-users');

API

slackUsers

Get the slack users for the specified team.

Params

options {Object}: Options object used for getting users.
options.team {String}: Name of slack team to get users from.
optins.token {String}: Slack token to use when getting users.
cb {Function}: Callback functions passing an error if one occurs or an array of users when successful.

Example

var options = {
  team: 'my-slack-team',
  token: 'my-slack-token'
};
slackUsers(options, function(err, users) {
  if (err) return console.error(err);
  console.log(users);
  //=> [
  //=>   {id: '', name: 'doowb', ...},
  //=>   {id: 'USLACKBOT', name: 'slackbot', ...}
  //=> ]
});

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

License

This file was generated by verb-generate-readme, v0.1.30, on August 29, 2016.

Usage no npm install needed!