added type declarations (#37)

* added declaration file

* added typescript

* added tsconfig

* use workspace ts

* removed unused file

* Revert "removed unused file"

This reverts commit 93e5114.

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

index.d.ts

@@ -0,0 +1,85 @@
+type ValueOf<T> = T[keyof T];
+
+export type Dtypes = {
+    "<u1": {
+        name: "uint8";
+        size: 8;
+        arrayConstructor: typeof Uint8Array;
+    };
+    "|u1": {
+        name: "uint8";
+        size: 8;
+        arrayConstructor: typeof Uint8Array;
+    };
+    "<u2": {
+        name: "uint16";
+        size: 16;
+        arrayConstructor: typeof Uint16Array;
+    };
+    "|i1": {
+        name: "int8";
+        size: 8;
+        arrayConstructor: typeof Int8Array;
+    };
+    "<i2": {
+        name: "int16";
+        size: 16;
+        arrayConstructor: typeof Int16Array;
+    };
+    "<u4": {
+        name: "uint32";
+        size: 32;
+        arrayConstructor: typeof Int32Array;
+    };
+    "<i4": {
+        name: "int32";
+        size: 32;
+        arrayConstructor: typeof Int32Array;
+    };
+    "<u8": {
+        name: "uint64";
+        size: 64;
+        arrayConstructor: typeof BigUint64Array;
+    };
+    "<i8": {
+        name: "int64";
+        size: 64;
+        arrayConstructor: typeof BigInt64Array;
+    };
+    "<f4": {
+        name: "float32";
+        size: 32;
+        arrayConstructor: typeof Float32Array;
+    };
+    "<f8": {
+        name: "float64";
+        size: 64;
+        arrayConstructor: typeof Float64Array;
+    };
+};
+
+export type Parsed = ValueOf<{
+    [K in keyof Dtypes]: {
+        dtype: Dtypes[K]["name"];
+        data: InstanceType<Dtypes[K]["arrayConstructor"]>;
+        shape: number[];
+        fortranOrder: boolean;
+    };
+}>;
+
+declare class npyjs {
+
+    constructor(opts?: never);
+
+    dtypes: Dtypes;
+
+    parse(arrayBufferContents: ArrayBuffer): Parsed;
+
+    load(
+        filename: RequestInfo | URL | ArrayBuffer,
+        callback?: (result?: Parsed) => any,
+        fetchArgs?: RequestInit
+    ): Promise<Parsed>;
+}
+
+export default npyjs;

package.json

@@ -11,7 +11,8 @@
         "node": "^12.20.0 || >=14.13.1"
     },
     "devDependencies": {
-        "mocha": "^10.2.0"
+        "mocha": "^10.2.0",
+        "typescript": "4.1.x"
     },
     "scripts": {
         "test": "mocha"

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  // Change this to match your project
+  "include": ["index.js"],
+  "compilerOptions": {
+    // Tells TypeScript to read JS files, as
+    // normally they are ignored as source files
+    "allowJs": true,
+    // Generate d.ts files
+    "declaration": true,
+    // This compiler run should
+    // only output d.ts files
+    "emitDeclarationOnly": true,
+    "target": "ES6"
+  }
+}