Files
Josh Goldberg 2d17b64723 chore: refactored ClassCyclr to not extend arrays, with tests (#342)
## Overview

Small cleanup/refactor I've been meaning to do for a while. It's weird
that ClassCyclr adds aritrary properties to arrays. This switches the
internal representation of cycles a bit to use `TimeCycle` objects with
a `classes: ClassesList` property.

And, now `ClassCyclr` is unit tested! 🙌 

### PR Checklist

-   ~[ ] Fixes #~
-   [x] I have run this code to verify it works
-   [x] This PR includes unit tests for the code change
2022-10-17 10:03:51 -04:00
..
2022-08-23 14:23:55 -04:00
2022-08-13 23:29:40 -04:00
2020-06-22 00:05:31 -04:00

ClassCyclr

Code Style: Prettier TypeScript: Strict NPM version Join the chat at https://gitter.im/FullScreenShenanigans/community

Cycles through class names using TimeHandlr events.

Usage

Constructor

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

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

Documentation coming soon™️!

Development

This repository is a portion of the EightBittr monorepo. See its docs/Development.md for details on how to get started. 💖

Running Tests

yarn 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 yarn 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, or run yarn test:run to run them in headless Chrome.