virgool-data

1.0.7 • Public • Published

Virgool Data

badge badge build passing Coverage Status

package for getting data of posts and user profile from virgool.io

Installation

npm install virgool-data

Usage

const virgoolData = require("virgool-data");

//get posts data
virgoolData.getPosts().then(posts => console.log(posts));

//get user data - username must be without "@"
//ex: const username = "imohamad";
virgoolData.getProfile(username).then(user => console.log(user));

posts output:

/* 
get posts data
virgoolData.getPosts().then(posts => console.log(posts));
*/

//output:
     [
        {
            "title": string, //تیتر مطلب
            "link": string, //لینک مطلب
            "reading": string, //خواندن ۲ دقیقه
            "time": string, // ۲ هفته پیش
            "category": string, // دسته بندی مطلب
            "summary": string, // خلاصه مطلب
            "cover": string, // تصویر مطلب
            "like": string, // تعداد لایک
            "comments": string, // تعداد نظرات
            "author": {
                "name": string, // نام نویسنده
                "username": string, // نام کاربری نویسنده
                "avatar": string // عکس پروفایل نویسنده
            }
        },
        {
          ...
        }
     ]

profile output:

/* 
get user data - username must be without "@"
ex: const username = "imohamad";
virgoolData.getProfile(username).then(user => console.log(user));
*/

//output:
 [
        {
            "name": string, // نام نویسنده
            "username": string, // نام کاربری نویسنده
            "avatar": string, // عکس پروفایل نویسنده
            "bio": string, // بیوگرافی نویسنده
            "followers": string, // دنبال کنندگان نویسنده
            "following": string, // دنبال شونده های نویسنده
            "postCount": number, // تعداد مطالب منتشر شده نویسنده
            "posts": [
                {
                    "title": string, // تیتر مطلب
                    "link": string, // لینک مطلب
                    "reading": string, // خواندن ۲ دقیقه
                    "time": string, // ۲ هفته پیش
                    "category": string, // دسته بندی مطلب
                    "summary": string, // خلاصه مطلب
                    "cover": string, // تصویر مطلب
                    "like": string, // تعداد لایک مطلب
                    "comments": string // تعداد کامنت های مطلب
                }
            ]
        }
]

enjoy! 🤘

Further help

visit imohamad or send e-mail: mohamad.partizan@gmail.com

Readme

Keywords

Package Sidebar

Install

npm i virgool-data

Weekly Downloads

1

Version

1.0.7

License

MIT

Unpacked Size

10.9 kB

Total Files

6

Last publish

Collaborators

  • imohamad