# self-service-banner

> Node.js API for Saint Mary's University Self-Service.

Latest version **0.2.1** (published 2014-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install self-service-banner
pnpm add self-service-banner
yarn add self-service-banner
bun add self-service-banner
```

## 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.1 |
| Published | 2014-09-03 |
| First published | 2014-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Glavin Wiechert |
| Maintainers | glavin001 |
| Keywords | self, service, banner, smu |

## Links

- npm: https://www.npmjs.com/package/self-service-banner
- Repository: https://github.com/SMU-CS-and-Math-Society/Self-Service.js
- Issues: https://github.com/SMU-CS-and-Math-Society/Self-Service.js/issues
- npm.io page: https://npm.io/package/self-service-banner

## Dependencies (2)

- [cheerio](https://npm.io/package/cheerio.md) 0.13.1
- [request](https://npm.io/package/request.md) 2.31.0

## Recent versions

- 0.2.1 (latest) — 2014-09-03
- 0.2.0 — 2014-09-03
- 0.1.1 — 2014-01-20
- 0.1.0 — 2014-01-09

## README

[Self-Service.js](https://github.com/SMU-CS-and-Math-Society/Self-Service)
===============

> Node.js API for Saint Mary's University Self-Service.

-----

## Installation

```bash
npm install self-service-banner --save
```

## Usage

```javascript
//
var selfService = require("self-service-banner");

// Login Credentials for Authentication
var creds = {
   "username": "A-Number",
   "password": "123567890"
};

// Create your connection instance.
var s = new selfService;

// Authenticate your connection by logging in with your credentials.
s.login({"username": creds.username, "password": creds.password }, function(error, response, localService) {
    if (!error) {
      // Successful
      localService.weekAtAGlance({ /*'startDate': new Date()*/ }, function(error, response, courses) {
          if (!error) {
              // Successful
              console.log("Completed!", courses);
          } else {
              // An error occured
              throw error;
          }
      });

    } else {
        // An Error occured.
        throw error;
    }

});


```

-----

## For Contributors

1) Use Git to clone this repository.

2) Download all of your dependencies.

```bash
npm install
```

3) Create your credentials file: `./credentials.json`

```json
{
    "username": "A-Number",
    "password": "password"
}
```

4) Test your credentials by running the built-in Unit Tests.

```bash
npm test
```

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