❤
npm
Sign UpSign In

circle-of-trust

1.3.0 • Public • Published

Circle of Trust

Get info about a user's circle.

Documentation

This package exports a function for getting a circle from a Reddit username (using ES6 Promises), like so:

const circleOfTrust = require("circle-of-trust");
circleOfTrust("haykam821")
    .then(console.log) // Circle information (see below)
    .catch(console.error); // Failed to get circle info (e.g. no such user or circle)

The promise resolves with an object containing information about the circle:

Property Type Description
circle.name String The name given to the circle
circle.link String A permalink to the circle
circle.id String The circle's identifier
circle.owner String The owner, good chance it'll be the person you specified.
circle.betrayed Boolean Whether the circle has been betrayed or not.
circle.score Number The score of the circle.
circle.key Null If key already used, that key as a String. Otherwise, Null.

Readme

Keywords

Package Sidebar

Install

npm i circle-of-trust

Repository

github.com/haykam821/Circle-of-Trust

Homepage

github.com/haykam821/Circle-of-Trust#readme

Weekly Downloads

1

Version

1.3.0

License

MIT

Unpacked Size

6.98 kB

Total Files

5

Last publish

Collaborators

  • haykam821
Try on RunKit
Report malware