Merge pull request #146 from vue-pivottable/ts-helper

defaultProps, redColorScaleGenerator 타입스크립트 전환

Author: gingerbeerlime

src/helper/defaultProps.js renamed to src/helper/defaultProps.ts

@@ -1,29 +1,31 @@
 import { aggregators, locales } from './utilities'
 import { redColorScaleGenerator } from './redColorScaleGenerator'
+import type { PropType } from 'vue'
+
 export default {
   data: {
-    type: [Array, Object, Function],
+    type: [Array, Object, Function] as PropType<any>,
     required: true
   },
   aggregators: {
-    type: Object,
+    type: Object as PropType<Record<string, Function>>,
     default: () => aggregators
   },
   aggregatorName: {
     type: String,
     default: 'Count'
   },
-  heatmapMode: String,
+  heatmapMode: String as PropType<'full' | 'col' | 'row' | ''>,
   tableColorScaleGenerator: {
     type: Function,
     default: redColorScaleGenerator
   },
   tableOptions: {
-    type: Object,
+    type: Object as PropType<Record<string, any>>,
     default: () => ({})
   },
   renderers: {
-    type: Object,
+    type: Object as PropType<Record<string, any>>,
     default: () => ({})
   },
   rendererName: {
@@ -35,7 +37,7 @@ export default {
     default: 'en'
   },
   languagePack: {
-    type: Object,
+    type: Object as PropType<Record<string, any>>,
     default: () => locales
   },
   showRowTotal: {
@@ -47,48 +49,48 @@ export default {
     default: true
   },
   cols: {
-    type: Array,
+    type: Array as PropType<string[]>,
     default: () => []
   },
   rows: {
-    type: Array,
+    type: Array as PropType<string[]>,
     default: () => []
   },
   vals: {
-    type: Array,
+    type: Array as PropType<string[]>,
     default: () => []
   },
   attributes: {
-    type: Array,
+    type: Array as PropType<string[]>,
     default: () => []
   },
   valueFilter: {
-    type: Object,
+    type: Object as PropType<Record<string, any>>,
     default: () => ({})
   },
   sorters: {
-    type: [Function, Object],
+    type: [Function, Object] as PropType<any>,
     default: () => ({})
   },
   derivedAttributes: {
-    type: [Function, Object],
+    type: [Function, Object] as PropType<any>,
     default: () => ({})
   },
   rowOrder: {
-    type: String,
+    type: String as PropType<'key_a_to_z' | 'value_a_to_z' | 'value_z_to_a'>,
     default: 'key_a_to_z',
-    validator: (value) =>
+    validator: (value: string) =>
       ['key_a_to_z', 'value_a_to_z', 'value_z_to_a'].indexOf(value) !== -1
   },
   colOrder: {
-    type: String,
+    type: String as PropType<'key_a_to_z' | 'value_a_to_z' | 'value_z_to_a'>,
     default: 'key_a_to_z',
-    validator: (value) =>
+    validator: (value: string) =>
       ['key_a_to_z', 'value_a_to_z', 'value_z_to_a'].indexOf(value) !== -1
   },
   tableMaxWidth: {
     type: Number,
     default: 0,
-    validator: (value) => value >= 0
+    validator: (value: number) => value >= 0
   }
 }

src/helper/index.js

@@ -1,3 +1,3 @@
 export { default as defaultProps } from './defaultProps.js'
-export { redColorScaleGenerator } from './redColorScaleGenerator.js'
+export { redColorScaleGenerator } from './redColorScaleGenerator'
 export * from './utilities.js'

src/helper/redColorScaleGenerator.js renamed to src/helper/redColorScaleGenerator.ts

@@ -1,7 +1,7 @@
-export function redColorScaleGenerator(values) {
+export function redColorScaleGenerator(values: number[]) {
   const min = Math.min.apply(Math, values)
   const max = Math.max.apply(Math, values)
-  return (x) => {
+  return (x: number) => {
     const nonRed = 255 - Math.round((255 * (x - min)) / (max - min))
     return { backgroundColor: `rgb(255,${nonRed},${nonRed})` }
   }