# steam-group

> Simple Steam community group members API.

Latest version **0.2.2** (published 2017-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install steam-group
pnpm add steam-group
yarn add steam-group
bun add steam-group
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2017-07-25 |
| First published | 2015-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+8 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Andrew Rogers |
| Maintainers | cpancake |
| Keywords | steam, groups, user |

## Links

- npm: https://www.npmjs.com/package/steam-group
- Repository: https://github.com/cpancake/steam-group
- Issues: https://github.com/cpancake/steam-group/issues
- npm.io page: https://npm.io/package/steam-group

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^3.8.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.8
- [cheerio](https://npm.io/package/cheerio.md) ^0.19.0
- [request](https://npm.io/package/request.md) ^2.55.0

## Recent versions

- 0.2.2 (latest) — 2017-07-25
- 0.2.1 — 2017-07-25
- 0.2.0 — 2017-07-10
- 0.1.0 — 2015-06-07

## README

# steam-group

Simple node.js library for fetching Steam community group members.

## Installation

You can install this library using npm:
```
npm install steam-group
```

## Example Usage

Usage is simple. First, you need to create a group object:
```
var steamGroup = require('steam-group');

var group = steamGroup.fromName('fp_programmers');
// or
var group = steamGroup.fromId64('103582791430091926');
```

Once you have a group object, you can use several methods for retrieving member information:
```
// accepts limit (the maximum number of members to find) and callback(err, result)
// result is an array of 64-bit community ID strings
group.getMembers(limit, callback);

// accepts callback(err, result)
// result is the 64-bit community ID string of the owner
group.getOwner(callback);

// same as group.getMembers
group.getOfficers(callback);
group.getModerators(callback);

// accepts callback(err, result)
// result is a boolean of whether or not the person is a member of this group
// this loads the group members if you haven't already! if you only want to, for example, check the first 1000 members, call getMembers first.
group.isMember(id, callback);

// accepts callback(err, result)
// result is either 'owner', 'officer', 'moderator', or 'member'
group.getMemberType(id, callback);
```

Group members are cached on the first use of the library (that is, the first time you use any of the functions). If you want to clear the cache without recreating the group object, you can use the clearCache function:
```
group.clearCache();
```

## License

The MIT License (MIT)

Copyright (c) 2017 Andrew Rogers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---
_Source: https://npm.io/package/steam-group · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._