Add TS types (#43)

* Add TS types

* Fix npm script

* Replaces `files` with `.npmignore`

.eslintignore

@@ -0,0 +1,2 @@
+types/index.d.ts
+types/index.test-d.ts

.npmignore

@@ -0,0 +1,10 @@
+.editorconfig
+.gitattributes
+.git
+.DS_Store
+.gitignore
+.github
+.dependabot
+.clinic
+tsconfig.json
+types/index.test-d.ts

package.json

@@ -3,8 +3,11 @@
   "version": "1.1.0",
   "description": "Extremely fast utf8 only stream implementation",
   "main": "index.js",
+  "type": "commonjs",
+  "types": "types/index.d.ts",
   "scripts": {
-    "test": "standard && tap --no-ts --no-jsx --no-esm -t 120 test.js"
+    "test": "npm run test:types && standard && tap --no-ts --no-jsx --no-esm -t 120 test.js",
+    "test:types": "tsc && tsd"
   },
   "repository": {
     "type": "git",
@@ -26,11 +29,14 @@
   },
   "homepage": "https://github.com/mcollina/sonic-boom#readme",
   "devDependencies": {
+    "@types/node": "^14.11.1",
     "fastbench": "^1.0.1",
     "husky": "^4.2.3",
     "proxyquire": "^2.1.0",
     "standard": "^14.0.0",
-    "tap": "^14.0.0"
+    "tap": "^14.0.0",
+    "tsd": "^0.13.1",
+    "typescript": "^4.0.3"
   },
   "dependencies": {
     "atomic-sleep": "^1.0.0",
@@ -40,5 +46,8 @@
     "hooks": {
       "pre-commit": "npm test"
     }
+  },
+  "tsd": {
+    "directory": "./types"
   }
 }

tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": [ "es2015" ],
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true
+  },
+  "include": [
+    "./types/index.test-d.ts",
+    "./types/index.d.ts"
+  ]
+}

types/index.d.ts

@@ -0,0 +1,48 @@
+// Type definitions for sonic-boom 0.7
+// Definitions by: Alex Ferrando <https://github.com/alferpal>
+//                 Igor Savin <https://github.com/kibertoad>
+/// <reference types="node"/>
+
+import { EventEmitter } from 'events';
+
+export default SonicBoom;
+
+declare class SonicBoom extends EventEmitter {
+    /**
+     * @param [fileDescriptor] File path or numerical file descriptor
+     * relative protocol is enabled. Default: process.stdout
+     * @returns a new sonic-boom instance
+     */
+    constructor(fileDescriptor: string | number, minLength?: number, sync?: boolean)
+
+    /**
+     * Writes the string to the file. It will return false to signal the producer to slow down.
+     */
+    write(string: string): void;
+
+    /**
+     * Writes the current buffer to the file if a write was not in progress.
+     * Do nothing if minLength is zero or if it is already writing.
+     */
+    flush(): void;
+
+    /**
+     * Reopen the file in place, useful for log rotation.
+     */
+    reopen(fileDescriptor?: string | number): void;
+
+    /**
+     * Flushes the buffered data synchronously. This is a costly operation.
+     */
+    flushSync(): void;
+
+    /**
+     * Closes the stream, the data will be flushed down asynchronously
+     */
+    end(): void;
+
+    /**
+     * Closes the stream immediately, the data is not flushed.
+     */
+    destroy(): void;
+}

types/index.test-d.ts

@@ -0,0 +1,18 @@
+import SonicBoom from '../';
+const sonic = new SonicBoom(1);
+
+sonic.write('hello sonic\n');
+
+sonic.flush();
+
+sonic.flushSync();
+
+sonic.reopen();
+
+sonic.end();
+
+sonic.destroy();
+
+const extraSonic = new SonicBoom(1, 0, true);
+
+extraSonic.write('extra sonic\n');