Add JSDocs and fix #19

Author: Hacksore

.github/workflows/publish.yaml

@@ -2,7 +2,7 @@ name: NPM
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   publish:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Sean Boult and contributors
+Copyright (c) 2022 Sean Boult and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-skinview3d",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "A React component for skinview3d Minecraft viewer",
   "author": "Hacksore",
   "license": "MIT",

rollup.config.js

@@ -25,5 +25,7 @@ export default {
     },
   ],
   external,
-  plugins: [resolve(), typescript(), babel(), commonjs()],
+  plugins: [resolve(), typescript({
+    tsconfig: './tsconfig.json'
+  }), babel(), commonjs()],
 };

src/index.tsx

@@ -5,12 +5,30 @@ import * as skinview3d from "skinview3d";
 // TODO: offscreen canvas support
 
 interface ISkinview3d {
-  className?: any; // TODO: type this
+  /**
+   * The class names to apply to the canvas
+   */
+  className?: string,
+  /**
+   * The width of the canvas
+   */
   width?: number;
+  /**
+   * The height of the canvas
+   */
   height?: number;
+  /**
+   * The skin to load in the canvas
+   */
   skinUrl?: string;
+  /**
+   * The cape to load in the cavas
+   */
   capeUrl?: string;
-  onReady?: Function;
+  /**
+   * A function that is called when the skin viewer is ready
+   */
+  onReady?: (skinview3d: skinview3d.SkinViewer) => void;
 }
 
 const Skinview3d = ({

tsconfig.json

@@ -1,16 +1,17 @@
 {
   "compilerOptions": {
     "declaration": true,
-    "declarationDir": "build",
+    "declarationDir": "",
     "module": "esnext",
     "target": "es6",
     "lib": ["es6", "dom", "es2016", "es2017"],
     "sourceMap": true,
     "jsx": "react",
+    "outDir": "dist",
     "moduleResolution": "node",
     "allowSyntheticDefaultImports": true,
     "esModuleInterop": true
   },
-  "include": ["src/**/*"],
+  "include": ["src/index.tsx"],
   "exclude": ["node_modules", "build"]
 }