What it is
A NodeJS module for interacting with the SMMDB (Super Mario Maker) api.
Installation
$ npm i --save smm-api
apiKey('KEY')
(optional) Sets the application SMMDB API key. Key is used for uploading and staring courses
Accepts one argument:
key
: SMMDB API Key
const smm = ; smm;
getStats(callback)
Gets overall SMMDB stats
Accepts one argument:
callback
: Callback run when method finisheserror
: An error, if there was onestats
: SMMDB stats
const smm = ; smm;
If no error, returns object:
courses
: Number of SMM courses (total 3DS and WiiU)courses64
: Number of SM64M (Super Mario 64 Maker) levelsaccounts
: Number of accounts
searchCourses({parameters}, callback)
Searchs SMMDB courses
Accepts two arguments:
parameters
: Search parameterscallback
: Callback run when method finisheserror
: An error, if there was onecourses
: Courses list For a list of accepted parameters, see https://github.com/Tarnadas/smmdb#receive-course-list
const smm = ; smm;
starUnstarCourse(courseId, callback)
Star and unstar a course (requires API key)
Accepts one argument:
callback
: Callback run when method finisheserror
: An error, if there was onecourse_data
: Data of the stared/unstared coures
const smm = ;smm; // Stars the coursesmm; // Unstars the course (call method 2nd time)smm;
downloadCourse(courseId, target, callback)
Downloads course by ID to a specified folder
Accepts three arguments:
courseId
: ID of the coursepath
: Path to folder to save course tocallback
: Callback run when method finisheserror
: An error, if there was one
const smm = ; smm
uploadCourse(buffer, callback)
Uploads course from given path (requires API key)
Accepts two arguments:
buffer
: Compressed level buffercallback
: Callback run when method finisheserror
: An error, if there was onecourse_data
: Data of the uploaded course
const smm = ;smm; let buffer = fs;smm