1.0.2 • Published 2 years ago

@astralservices/roblox v1.0.2

Weekly downloads
-
License
MPL-2.0
Repository
-
Last release
2 years ago

@astralservices/roblox

A simple Node.js wrapper for the Roblox API. Made from the ground up with full Typescript support.

⚠️ Warning

This module is still in heavy development, expect things to break. Production use isn't recommended, but it should work.

About

This module is a simple Node.js wrapper for the Roblox API.

Key features

Get started

Installation

yarn add @astralservices/roblox or npm install @astralservices/roblox

Example code

import Client from '@astralservices/roblox';

const client = new Client({
  cookie: process.env.ROBLOX_COOKIE, // optional if you just want public API usage
});

// Get a group

client.groups.fetch(13619939).then((group) => {
  console.log(`Fetched ${group.name} (${group.id})!`);
});

// Get a user

client.users.fetch(59692622).then((user) => {
  console.log(`Fetched ${user.username} (${user.id})!`);
});

Documentation

Soon:tm: