Skip to content
This repository has been archived by the owner on May 5, 2021. It is now read-only.
/ speedrun.js Public archive

speedrun.com API inplementation for Node.js apps (Project stopped)

License

Notifications You must be signed in to change notification settings

GreepTheSheep/speedrun.js

Repository files navigation

speedrun.com API library for Node.js apps

NPM

GitHub issues GitHub forks GitHub stars

GitHub package.json version npm Depfu

Build Status

Installation

npm i speedrun.js

Usage

This following example uses async/await, you can also use .then()

// Import the module:
const speedrun = require("speedrun.js");

async function speedrunJsExamples(){
    var out;

    // Get game information:
    out = await speedrun.games.getGameByAbbreviation('hl2')
    console.log(out.names.international) // hl2 will output Half-Life 2

    // Search games and get information
    out = await speedrun.games.getGamesByName('Watch Dogs')
    console.log(out) // This will output an array of information containing Watch Dogs in the name
}

speedrunJsExamples()

Refer to the examples dir for more examples

Checklist to do

  • Finish API (get anything with functions)
  • Documentate as fast as possible
  • Logo for the Readme and for the website
  • Beat node-speedrun's PB (jk, you can use this lib while I make mine)

About

speedrun.com API inplementation for Node.js apps (Project stopped)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published