@eclipse-utilities/blox.js
v1.2.2
Published
ROBLOX API wrapping, simplified.
Readme
Get a list of users by a keyword
const { getUsersByKeyword } = require('@eclipse-utilities/blox.js')
await getUsersByKeyword(keyword)Returns an array or null
Get avatar by ID
const { getAvatar } = require('@eclipse-utilities/blox.js')
await getAvatar(userId, type, size)type - 'avatar' (default), 'headshot', 'bust'size - defaults to '720x720'
Returns a string or null
Get users by username(s)
const { getUsersByUsernames } = require('@eclipse-utilities/blox.js')
await getUsersByUsernames(usernames, excludeDeletedUsers)Returns an array or null
Get user by username
const { getUserByUsername } = require('@eclipse-utilities/blox.js')
await getUserByUsername(username)Returns a JSON object or null
Get previous usernames by ID
const { getPastUsernames } = require('@eclipse-utilities/blox.js')
await getPastUsernames(userId)Returns an array or null
Get user by ID
const { getUserByID } = require('@eclipse-utilities/blox.js')
await getUserByID(userId)Returns a JSON object or null
Get user presence
const { getUserPresence } = require('@eclipse-utilities/blox.js')
await getUserPresence(userId)
await getUserPresence([userId1, userId2])Returns a presence object or array or null
Get user groups
const { getUserGroups } = require('@eclipse-utilities/blox.js')
await getUserGroups(userId)Returns an array or null
Get user friend count
const { getUserFriendCount } = require('@eclipse-utilities/blox.js')
await getUserFriendCount(userId)Returns a number or null
Get user follower count
const { getUserFollowerCount } = require('@eclipse-utilities/blox.js')
await getUserFollowerCount(userId)Returns a number or null
Check if inventory is visible
const { canViewInventory } = require('@eclipse-utilities/blox.js')
await canViewInventory(userId, apiKey)Requires a Roblox Open Cloud API key with Inventory Read access.
Returns true, false, or null
Get user badges
const { getUserBadges } = require('@eclipse-utilities/blox.js')
await getUserBadges(userId, apiKey)Requires a Roblox Open Cloud API key with Inventory Read access.
Returns null if the user's inventory is private.
Returns an array of badge objects.
