Skip to content

SuperCater/WrapBlox

Repository files navigation

WrapBlox

uhh hii this is for future purple to not forget ok ignore this thanks: docs locally: mkdocs serve deploy to pages: mkdocs gh-deploy

Wrapblox is a promise based API wrapper for the Roblox API written in typescript. It is currently in development and really isnt meant for production.

Installation

Install using NPM

npm install wrapblox

Usage

import WrapBlox from "wrapblox";

const wrapblox = new WrapBlox("optional cookie");

const user = await wrapblox.fetchUser(1); // Returns a user object

Reasons to use WrapBlox

WrapBlox was made mainly just because i didnt like how alternative librarys worked for one reason or another. The main benefit of this over using something like noblox.js is that it doesnt use any extra dependencies and uses built in node functions.

Wrapblox is written in typescript so if you are using typescript you will get proper type checking with it.

FAQ

  • Why are some methods missing?
    • Answer 1: WrapBlox is still in development and is missing some methods. If you need a method that is missing you can make a pull request or open an issue.
    • Answer 2: WrapBlox doesnt include methods that require captcha solving as that is not something that can be done with an API wrapper.

About

A promise based wrapper for the Roblox API

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published