@colorsystem/api-typings

ColorSystem.io API typings

This repository contains the typings for the ColorSystem.io API.

Usage

1. Installation

   npm i -D @colorsystem/api-typings
   # or
   yarn add -D @colorsystem/api-typings
   

2. Configure tsconfig.json

   {
     "compilerOptions": {
       "typeRoots": ["./node_modules/@colorsystem"]
     }
   }
   

   The configuration above is needed for the TypeScript compiler to use type definitions found in ./node_modules/@colorsystem. Normally, most external type definitions are from DefinitelyTyped and are installed in /@types, which included by TypeScript by default. Since we host the api typings separately, they are installed outside in /@colorsystem instead.

   Types should become globally available without needing to use import statements.