README.md

src-ts

A TypeScript library providing functions to interface with and to describe the shape of the public speedrun.com REST API (v1).

• Types are defined under /types.
• Other utilities are defined under /src.

Find the package on npmjs.com here.

DISCLAIMER: Functions that perform API requests are only added as I need them / they are requested. If one is missing, open an issue and I'll add it for you.

Installation

With Node and npm installed (or equivalent):

npm i src-ts

If you wish to just use the type definitions provided (under /types), I recommend you install as a dev dependency only (with the --save-dev flag).

Use

Import or require from 'src-ts' and you will have access to everything.

I recommend you use an identifier such as SRC to house the library, like so:

// Modules
import * as SRC from 'src-ts';
// CommonJS
const SRC = require('src-ts');	

SRC.getGame('wys');	// returns a promise

But nothing stops you from doing it like so:

// Modules
import { getGame } from 'src-ts';
// CommonJS
const { getGame } = require('src-ts');

getGame('wys');

For TypeScript, access is provided to the types under the same import:

import * as SRC from 'src-ts';

function doThingWithGame(game: SRC.Game) { ... }

Or, using the second method:

import { Game } from 'src-ts';

function doThingWithGame(game: Game) { ... }

Extensive documentation on functions and types can be found on the wiki is coming to the wiki, eventually.

Build & Local Install

Clone or fork the repository, and then run the build npm script:

git clone https://github.com/mitchell-merry/src-ts.git
npm install

# Build library files & pack to tarball
npm run build
npm pack

To install the tarball in another project:

npm install <path-to-tarball>

For example, if I have a project test-p next to my clone of src-ts:

# Creates /lib folder in src-ts
src-ts> npm run build
# Creates 'src-ts-<version>.tgz' in src-ts
src-ts> npm pack
src-ts> cd ../test-p
# Installs the local package
test-p> npm install ../src-ts/src-ts-<version>.tgz