# yojs

> YoJS is a dead simple Node.js module for the Yo API.

Latest version **0.1.0** (published 2015-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install yojs
pnpm add yojs
yarn add yojs
bun add yojs
```

## 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.1.0 |
| Published | 2015-06-03 |
| First published | 2015-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | David Vas, anuka |
| Maintainers | anuka |
| Keywords | yo, just yo, api, wrapper, simple, dead simple |

## Links

- npm: https://www.npmjs.com/package/yojs
- Repository: https://github.com/Anubisss/yojs
- Issues: https://github.com/Anubisss/yojs/issues
- npm.io page: https://npm.io/package/yojs

## Dependencies (1)

- [request](https://npm.io/package/request.md) ^2.57.0

## Recent versions

- 0.1.0 (latest) — 2015-06-03

## README

# YoJS
YoJS is a dead simple Node.js module for the [Yo](http://justyo.co/) API.

[Just Yo](http://justyo.co/) is the simplest and most efficient (zero) communication tool in the world.

YoJS's goal is simplicity. Because of this there is literally no error handling in the module. If something goes wrong then the response (in the callback) of the Yo API contains the error message and gives a non 200 HTTP status code.

[![NPM](https://nodei.co/npm/yojs.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/yojs)

## Install

* directly from the git repository: ```git clone https://github.com/Anubisss/yojs```
* from the [npm](https://www.npmjs.com/) registry: ```npm install yojs```
* from the [bower](http://bower.io/) registry: ```bower install yojs```

## Usage
```javascript
var YoJS = require('yojs');

 // Your Yo account's API token/key.
 // Or you can set it via the YO_API_TOKEN environment variable.
var yoApiToken = '';
console.log('Trying to Yo...');
YoJS.yo('', yoApiToken, 'yoteam', '', '', function(err, res, body) {
  if (err) {
    console.log('Error: %s', err);
  } else {
    console.log('Success.');
  }
  console.log('res.statusCode: %s', res.statusCode);
  console.log('body: %s', body);
  // If you want to parse the body.
  var parsedBody = JSON.parse(body);
});

```

## Examples
Examples for how to use YoJS are in the example directory. You have to set the YO_API_TOKEN environment variable to try out the examples. YO_API_TOKEN have to contain your Yo account's API token/key.

## More details about the API
If you need more details about Yo's API then you should check this out: http://docs.justyo.co/v1.0/docs

## License
The MIT License (MIT)

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