Scratch-site-api NPM

scratch-site-api

scratch-site-api is a full library for working with the Scratch website with Node.JS

Classes

User, a user class containing all methods for user accounts
CloudSession, a class for interacting with cloud data

Methods

User (all methods unless otherwise stated are async)

login, take a username and password to login
signOut, sign out and invalidate the current session
getSession, get information about a session
changeCountry, change account country (Can be any valid country, first letter must be capitalized)
changePassword, change account password, takes the old account password and the new password
changeEmail, change account email, takes the account password and new email
messages.getMessages, get account messages, takes an offset and limit
messages.getCount, get account message count
profile.toggleComments, toggle commenting on user profile
profile.setStatus, takes a string to set user's WIWO to
profile.setBio, takes a string to set user's bio to
profile.setProfilePicture, takes a buffer and mime type to set user's profile picture to
comments.commentOnUser, takes a string and username to comment on, also takes a comment id and commentee id for replying
comments.commentOnProject, takes a string and project id to comment on, also takes a comment id and commentee id for replying
cloud.createSession, takes a project id to create a cloud session on

CloudSession

Methods

get, get a cloud variable, takes a name (with ☁ icon) and returns the value
set, set a cloud variable, takes a name (with ☁ icon) and value

Events

set, fired when a cloud variable is set, returns (with ☁ icon) name and value
handshake, fired when a handshake with the cloud server is performed
packet, fired when a packet is recieved, returns the parsed packet
outgoing, fired when there is an outgoing packet, returns the outgoing packet

Examples

const Scratch = require("scratch-site-api")
const user = new Scratch.User()

async function main() {
    await user.login("username", "password")

    console.log(await user.getSession().json)
}

Create a cloud session and log all variables

const Scratch = require("scratch-site-api")
const user = new Scratch.User()

async function main() {
    await user.login("username", "password")

    const cloud = user.cloud.createSession(12345678)
    cloud.on("set", (var, val) => {
        console.log(var, val)
    })
}