devrant - npm Package Compare versions
Comparing version 0.0.3 to 0.0.4
| { | ||
| "name": "devrant", | ||
| "version": "0.0.3", | ||
| "version": "0.0.4", | ||
| "description": "Unofficial wrapper for the public devRant API.", | ||
@@ -5,0 +5,0 @@ "main": "src/index.js", |
@@ -5,3 +5,3 @@ # devRant | ||
| [npm-image]: https://img.shields.io/badge/npm-v0.0.3-blue.svg | ||
| [npm-image]: https://img.shields.io/badge/npm-v0.0.4-blue.svg | ||
| [npm-url]: https://www.npmjs.com/package/devrant | ||
@@ -26,2 +26,8 @@ [travis-image]: https://travis-ci.org/danillouz/devrant.svg?branch=master | ||
| ## devRant Display Requirements | ||
| When displaying the contents of a rant fetched from the | ||
| [devRant](https://www.devrant.io/) API, it is **required** | ||
| to credit the author of a rant by displaying their devRant | ||
| username. | ||
| ## Syntax | ||
@@ -41,6 +47,6 @@ ```javascript | ||
| | --- | --- | --- | --- | | ||
| | [rant](#rantid) | Yes | `Promise` | Retrieve a single rant from devRant. Use this method to retrieve a rant with its full text and comments. _The retrieved rant is [Full Rant Object](#rant-object-full)._ | | ||
| | [rants](#rantsoptions) | Optional | `Promise` | Retrieve rants from devRant. _The retrieved rants are [Simple Rant Objects](#rant-object-simple)._ | | ||
| | [search](#searchterm) | Yes | `Promise` | Retrieve rants from devRant that match a specific search term. _The retrieved rants are [Simple Rant Objects](#rant-object-simple)._ | | ||
| | [profile](#profileusername) | Yes | `Promise` | Retrieve the profile of a devRant user by username. | | ||
| | [rant](#rantid) | Yes | `Promise` | Retrieve a single rant from devRant. Use this method to retrieve a rant with its full text and comments. The retrieved rant is a [Full Rant Object](#rant-object-full). | | ||
| | [rants](#rantsoptions) | Optional | `Promise` | Retrieve rants from devRant. The retrieved rants are [Simple Rant Objects](#rant-object-simple). | | ||
| | [search](#searchterm) | Yes | `Promise` | Retrieve rants from devRant that match a specific search term. The retrieved rants are [Simple Rant Objects](#rant-object-simple). | | ||
| | [profile](#profileusername) | Yes | `Promise` | Retrieve the profile of a devRant user by username. The retrieved profile is a [Profile Object](#profile-object). | | ||
@@ -51,3 +57,3 @@ ### .rant(id) | ||
| _The retrieved rant is [Full Rant Object](#rant-object-full)._ | ||
| The retrieved rant is a [Full Rant Object](#rant-object-full). | ||
@@ -69,3 +75,3 @@ ###### Arguments | ||
| _The retrieved rants are [Simple Rant Objects](#rant-object-simple)._ | ||
| The retrieved rants are [Simple Rant Objects](#rant-object-simple). | ||
@@ -80,3 +86,3 @@ ###### Arguments | ||
| | --- | --- | --- | --- | | ||
| | sort | String | **Optional**. The type of rants to be fetched. Must be `algo`, `recent` or `top`. When omitted, it defaults to `algo` | | ||
| | sort | String | **Optional**. The type of rants to be fetched. Must be `algo`, `recent` or `top`. When omitted, it defaults to `algo`. | | ||
| | limit | Number | **Optional**. The amount of rants to be fetched. When omitted, it defaults to `50`. | | ||
@@ -92,3 +98,3 @@ | skip | Number | **Optional**. The amount of rants to be skipped. When omitted, it defaults to `0`. | | ||
| _The retrieved rants are [Simple Rant Objects](#rant-object-simple)._ | ||
| The retrieved rants are [Simple Rant Objects](#rant-object-simple). | ||
@@ -106,2 +112,4 @@ ###### Arguments | ||
| The retrieved profile is a [Profile Object](#profile-object). | ||
| ###### Arguments | ||
@@ -108,0 +116,0 @@ | NAME | TYPE | DESCRIPTION | |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.22%
151078
- Number of lines in readme file
- increased by2.29%
358