# plague-api
> Plague Social Platform NodeJS API
Latest version **1.0.92** (published 2015-02-19) · 0 weekly downloads
## Install
```sh
npm install plague-api
pnpm add plague-api
yarn add plague-api
bun add plague-api
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.92 |
| Published | 2015-02-19 |
| First published | 2014-12-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Kauê Gimenes |
| Maintainers | kauegimenes |
| Keywords | Plague, API, Node |
## Links
- npm: https://www.npmjs.com/package/plague-api
- Repository: https://github.com/kauegimenes/plague-api
- Issues: https://github.com/kauegimenes/plague-api/issues
- npm.io page: https://npm.io/package/plague-api
## Dependencies (1)
- [request](https://npm.io/package/request.md) ~2.51.0
## Alternatives
- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads
## Recent versions
- 1.0.92 (latest) — 2015-02-19
- 1.0.91 — 2015-02-19
- 1.0.9 — 2015-02-19
- 1.0.8 — 2015-02-19
- 1.0.7 — 2015-02-19
- 1.0.6 — 2015-02-19
- 1.0.5 — 2015-02-19
- 1.0.4 — 2015-01-08
- 1.0.2 — 2014-12-26
- 1.0.1 — 2014-12-26
- 1.0.0 — 2014-12-26
## README
# plague-api
[](https://nodei.co/npm/plague-api/)
[](https://travis-ci.org/kauegimenes/plague-api) [](https://gitter.im/kauegimenes/plague-api?utm_source=badge)
Plague Social Platform NodeJS API Changelog
----------------------
v1.09 - include badges
v1.08 - include tests
v1.07 - new methods - resetPassword and confirmEmail
v1.06 - option to change locality using set function
v1.05 - fix encoding problem
v1.04 - register method
set(options)
----------------------
Set Plague Api Options
#### Parameters:
**options:** Use this to set your location.
#### Sample Code:
```javascript
var plague = require('plague-api').set({
latitude: -99.999999999999,
longitude: -99.999999999999,
administrativeArea: 'Quebec',
country: 'Canada',
locality: 'Montreal'
});
```
register(email, password, name, callback)
--------------------
Register to get UserId and Token
#### Parameters:
**email:** Your user email.
**password:** Your user password.
**name:** Your name.
**callback:** callback function.
#### Sample Code:
```javascript
plague.register('sample@domain.com', 'mypassword', 'My Name', function(user){
if(user.error){
console.log(user.error);
return;
}
console.log(user);
});
```
login(email, password, callback)
--------------------
Login to get UserId and Token
#### Parameters:
**email:** Your plague user email.
**password:** Your plague user password.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
console.log(user);
});
```
confirmEmail(email, code, callback)
--------------------
Confirm user e-mail
#### Parameters:
**email:** Your plague user email.
**code:** Your plague confirmation code.
**callback:** callback function.
#### Sample Code:
```javascript
plague.confirmEmail('sample@domain.com', '1234', function(res){
console.log(res);
});
```
resetPassword(email, code, callback)
--------------------
Reset user password using e-mail
#### Parameters:
**email:** Your plague user email.
**code:** Your plague confirmation code.
**callback:** callback function.
#### Sample Code:
```javascript
plague.resetPassword('sample@domain.com', '1234', function(res){
console.log(res);
});
```
getPosts(callback)
----------------------
Return all user posts
#### Parameters:
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
//List all user posts
plague.getPosts(function(res){
var posts = res.posts;
posts.forEach(function(post) {
console.log(post);
})
});
});
```
getInfectionsNearby(callback)
----------------------
Return Nearby Plagues
#### Parameters:
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.getInfectionsNearby(function(res){
console.log(res);
});
});
```
postText(text, callback)
----------------------
Send a text only post to Plague API
#### Parameters:
**text:** Text of the post.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.postText('Hello Plague', function(res){
console.log(res);
});
});
```
postLink(mediaLink, mediaLinkPreview, text, callback)
----------------------
Send a post with a Media Link
#### Parameters:
**mediaLink:** Url of the image should be around **600x600** pixels.
**mediaLinkPreview:** Url of the image should be around **300x300** pixels.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.postLink(
'http://domain.com/imageFull.png',
'http://domain.com/imageSmall.png',
'Hello! =)',function(res){
console.log(res);
});
});
```
deletePost(postId, callback)
----------------------
Delete a post using postId
#### Parameters:
**postId:** This is the id returned from **getPosts**.
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.deletePost(123456,function(res){
console.log(res);
});
});
```
deleteAllPosts(postId, callback)
----------------------
Delete all user posts
#### Parameters:
**callback:** callback function.
#### Sample Code:
```javascript
plague.login('sample@domain.com', 'mypassword', function(user){
if(user.error){
console.log(user.error);
return;
}
plague.deleteAllPosts(function(res){
console.log(res);
});
});
```
---
_Source: https://npm.io/package/plague-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._