coloroo
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

Coloroo

Work-in-progress TypeScript/JavaScript library for colors, color-space, conversion, and manipulation.

Motivation (or Why This Library?)

I wanted a modern feeling API that uses TypeScript as a first-class citizen for Color containers and manipulation. Other libraries I've seen seem to have slightly complicated APIs, or the TypeScript definitions are an after-thought, or the code bases for them in general are generally hard to read.

Additional to this, I wanted to explore as many color-spaces and encoding formats as I could for this project while remaining flexible to add more as needed.

Installation

Like most libraries, it's the same ol' story:

npm install --save coloroo
yarn add coloroo

Test Coverage

Testing is provided by Mocha/Chai, with coverage reporting done by Istanbul/NYC.

Current test coverage is as follows:

File % Stmts % Branch % Funcs % Lines
All files 100 100 100 100
src 100 100 100 100
NamedColors.ts 100 100 100 100
RGB.ts 100 100 100 100
src/utils 100 100 100 100
math.ts 100 100 100 100
params.ts 100 100 100 100
regexp.ts 100 100 100 100

Contibuting

I welcome contributions if you have some. Currently I don't have any formatting requirements since this is mostly a pasion project at the time. So I suppose, just fill out an issue or PR as per usual for repos.

License

Under the MIT licens, see LICENSE file for more details.

/coloroo/

    Package Sidebar

    Install

    npm i coloroo

    Weekly Downloads

    0

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    604 kB

    Total Files

    84

    Last publish

    Collaborators

    • chrispikul510