import { ClassCyclr } from "classcyclr";
import { TimeHandlr } from "timehandlr";

const timeHandler = new TimeHandlr();
const classCycler = new ClassCyclr({ timeHandler });

Documentation coming soon^tm!

Development

After forking the repo from GitHub:

git clone https://github.com/<your-name-here>/ClassCyclr
cd ClassCyclr
npm install
npm run setup
npm run verify

npm run setup creates a few auto-generated setup files locally.
npm run verify builds, lints, and runs tests.

Building

npm run watch

Source files are written under src/ in TypeScript and compile in-place to JavaScript files. npm run watch will directly run the TypeScript compiler on source files in watch mode. Use it in the background while developing to keep the compiled files up-to-date.

Running Tests

npm run test

Tests are written in Mocha and Chai. Their files are written using alongside source files under src/ and named *.test.ts?. Whenever you add, remove, or rename a *.test.t* file under src/, watch will re-run npm run test:setup to regenerate the list of static test files in test/index.html. You can open that file in a browser to debug through the tests.