Export type names (#27)

nicfv · Mar 6, 2024 · e85079a · e85079a
1 parent 80cd4c9
commit e85079a
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/viridis/CHANGELOG.md b/viridis/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.1
+
+- Export palette name type
+
 ## 1.0.0
 
 - Add color palettes on readme

diff --git a/viridis/package.json b/viridis/package.json
@@ -1,6 +1,6 @@
 {
   "name": "viridis",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Generate data visualization color gradients",
   "main": "dist/index.js",
   "types": "types/index.d.ts",

diff --git a/viridis/src/Palette.ts b/viridis/src/Palette.ts
@@ -1,6 +1,11 @@
 import { Color } from './Color';
 import { Gradient } from './Gradient';
 
+/**
+ * Defines the list of valid builtin palette names.
+ */
+export type PaletteName = 'Viridis' | 'Inferno' | 'Magma' | 'Plasma' | 'Grayscale' | 'Parula' | 'Emerald' | 'Mint' | 'Sunset' | 'Dusk' | 'Chroma' | 'Spectral' | 'Cool' | 'Warm' | 'Turquoise' | 'Purplish' | 'Dirt' | 'Lime' | 'Teal' | 'Bee';
+
 /**
  * Contains builtin color palettes.
  * 
@@ -9,7 +14,7 @@ import { Gradient } from './Gradient';
  * - Loading Colors: https://loading.io/color/feature/
  * - Carto Colors: https://carto.com/carto-colors/
  */
-export const Palette = {
+export const Palette: { [name in PaletteName]: Gradient } = {
     // https://waldyrious.net/viridis-palette-generator/
     Viridis: new Gradient([
         Color.from('#fde725'),