Skip to content

Commit 184be5c

Browse files
authored
feat(typescript): Add basic typescript definitions
Adds basic type definitions - Fixes #376
1 parent ca9c1f4 commit 184be5c

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,12 @@
4040
"unpkg": "dist/vue-chartjs.min.js",
4141
"module": "es/index.js",
4242
"jsnext:main": "es/index.js",
43+
"typings": "types/index.d.ts",
4344
"files": [
4445
"src",
4546
"dist",
46-
"es"
47+
"es",
48+
"types/*.d.ts"
4749
],
4850
"scripts": {
4951
"dev": "node build/dev-server.js",

types/components.d.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import Vue from 'vue'
2+
3+
/** vue-chartjs component common definition */
4+
export declare class BaseChart extends Vue {
5+
addPlugin (plugin?: string[]): void
6+
renderChart (chartData: any, options?: any): void
7+
}

types/index.d.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { BaseChart } from './components'
2+
3+
declare module 'vue-chartjs' {
4+
export function generateChart(chartId: string, chartType: string): any;
5+
export class Bar extends BaseChart {}
6+
export class HorizontalBar extends BaseChart {}
7+
export class Doughnut extends BaseChart {}
8+
export class Line extends BaseChart {}
9+
export class Pie extends BaseChart {}
10+
export class PolarArea extends BaseChart {}
11+
export class Radar extends BaseChart {}
12+
export class Bubble extends BaseChart {}
13+
export class Scatter extends BaseChart {}
14+
export const mixins: {
15+
reactiveData: any
16+
reactiveProp: any
17+
}
18+
}
19+

0 commit comments

Comments
 (0)