JSPM

@colorsystem/api-typings

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q30166F
  • License MIT

TypeScript definitions for the ColorSystem.io API

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@colorsystem/api-typings) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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.