replapi-it

    2.4.0-beta.2 • Public • Published

    ⚠️ IMPORTANT: Documentation is broken, will fix soon ⚠️

    ⚠️ IMPORTANT: ReplAPI.it is now in version 2.x! Any projects transitioning to 2.x should read through this. ⚠️

    Contributors Forks Stargazers Issues MIT License Downloads


    Logo

    ReplAPI.it

    A Simple and Complete Replit API Package
    Explore the docs »

    View Package on NPM · Report Bug · Request Feature

    Table of Contents

    1. About The Project
    2. Getting Started
    3. Usage
    4. Roadmap
    5. Contributing
    6. License
    7. Contact
    8. Acknowledgements

    About The Project

    Code Screenshot

    The Replit GraphQL API is an extraordinary way to make projects unique and special, yet with the numerous packages available few such projects have been made. Why would that be? Most likely due to how complicated writing code can get and the limitations of their queries. My package, ReplAPI.it, changes that with a simple to use structure and many queries, some of which are:

    • Queries for Data on Users (such as Profile, Posts, Comments)
    • Queries for Data on Posts (such as Upvoters, Content)
    • Queries for Data on Repls (such as Files, Comments)
    • Mutations for Commenting, Reporting, and Posting
    • Queries for Data on Leaderboard (with filters such as cycles since)
    • and lots more!

    My package is also simple to use with it's class-based structure. Simply create a new class for your User, Post, or whatever your heart desires and use built in functions with options to query data your way.

    Built With

    Getting Started

    I suggest requiring the ReplAPI.it module until ES imports in NodeJS are stabilized.

    Prerequisites

    If you have not already download npm:

    • npm
      npm install npm@latest -g

    Installation

    1. Install the latest version of the package
      $ npm install replapi-it
    2. Require the package in your code
      import ReplAPI from 'replapi-it';
    3. Initilize the package
      const replapi = ReplAPI({
         username: 'your-username-here'
      });

    Usage

    Using ReplAPI.it is very simple! Let's create a simple user and ask for their cycles:

    import ReplAPI from 'replapi-it';
    const replapi = ReplAPI({
      username: 'your-username-here'
    });
    
    const myUser = new replapi.User("RayhanADev");
    
    async function getCycles() {
      let info = await myUser.userGraphQLDataFull();
      let cycles = info.karma; // Yep, it's karma!
      console.log(`User Cycles: ${cycles}`)
    }
    
    getCycles()

    Output:

    User Cycles: 1008
    

    That was fun! Now how about getting a specific post? Let's create a simple post and ask for it's title:

    import ReplAPI from 'replapi-it';
    const replapi = ReplAPI({
      username: 'your-username-here'
    });
    
    const myPost = new replapi.Post(78043);
    
    async function getTitle() {
      let info = await myPost.postDataFull();
      let title = info.title;
      console.log(`Post Title: ${title}`)
    }
    
    getTitle()

    Output:

    Post Title: Presenting... 🤔 RayhanADev 🤔? (GraphQL Success!)
    

    For more examples, please refer to the Documentation

    Roadmap

    See the open issues for a list of proposed features (and known issues).

    I'm considering adding in support for Crosis communications after they distribute developer keys again. Right now I'm experimenting with WSS and eval.repl.it for code execution!

    Contributing

    Contributions are much appreciated, and if you have a cool idea that feels right in this package then you should check out our contributing page.

    License

    Distributed under the GPL-3.0 License. See LICENSE for more information.

    Contact

    RayhanADev - @RayhanADev - rayhanadev@protonmail.com

    Project Link: https://github.com/ReplAPI-it/ReplAPI.it-NodeJS

    Acknowledgements

    Install

    npm i replapi-it

    DownloadsWeekly Downloads

    1

    Version

    2.4.0-beta.2

    License

    GPL-3.0-or-later

    Unpacked Size

    71.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar