npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

smm-api

v2.1.2

Published

A NodeJS module for interacting with the SMMDB (Super Mario Maker) api

Downloads

14

Readme

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 = require('smm-api');
    
smm.apiKey('KEY');

getStats(callback)

Gets overall SMMDB stats

Accepts one argument:

  • callback: Callback run when method finishes
    • error: An error, if there was one
    • stats: SMMDB stats
const smm = require('smm-api');

smm.getStats((error, stats) => {
	if (error) throw error;
	console.log(stats);
});

If no error, returns object:

  • courses: Number of SMM courses (total 3DS and WiiU)
  • courses64: Number of SM64M (Super Mario 64 Maker) levels
  • accounts: Number of accounts

searchCourses({parameters}, callback)

Searchs SMMDB courses

Accepts two arguments:

  • parameters: Search parameters
  • callback: Callback run when method finishes
    • error: An error, if there was one
    • courses: Courses list For a list of accepted parameters, see https://github.com/Tarnadas/smmdb#receive-course-list
const smm = require('smm-api');

smm.searchCourses({
	title: 'Test'
}, (error, courses) => {
	if (error) throw error;
	console.log(courses);
});

starUnstarCourse(courseId, callback)

Star and unstar a course (requires API key)

Accepts one argument:

  • callback: Callback run when method finishes
    • error: An error, if there was one
    • course_data: Data of the stared/unstared coures
const smm = require('smm-api');
smm.apiKey('API_KEY');

// Stars the course
smm.starUnstarCourse('59ab69804fa8fa5fb0946df3', (error, course_data) => {
	if (error) throw error;
	console.log(course_data);
    // Course is now stared by you
});

// Unstars the course (call method 2nd time)
smm.starUnstarCourse('59ab69804fa8fa5fb0946df3', (error, course_data) => {
	if (error) throw error;
	console.log(course_data);
    // Course is now unstared by you
});

downloadCourse(courseId, target, callback)

Downloads course by ID to a specified folder

Accepts three arguments:

  • courseId: ID of the course
  • path: Path to folder to save course to
  • callback: Callback run when method finishes
    • error: An error, if there was one
const smm = require('smm-api');
    
smm.downloadCourse('59722397f160681a439d9b92', './', (error) => {
	if (error) throw error;
	console.log('Done');
})

uploadCourse(buffer, callback)

Uploads course from given path (requires API key)

Accepts two arguments:

  • buffer: Compressed level buffer
  • callback: Callback run when method finishes
    • error: An error, if there was one
    • course_data: Data of the uploaded course
const smm = require('smm-api');
smm.apiKey('API_KEY');

let buffer = fs.readFileSync('Course.zip');
smm.uploadCourse(buffer, 'Test Course', (error, course_data) => {
	if (error) throw error;
	console.log(course_data);
})