Port utils to TypeScript (#1019)

Author: EzraBrooks

src/util/cborTypedArrayTags.js renamed to src/util/cborTypedArrayTags.ts

@@ -12,9 +12,9 @@ function warnPrecision() {
 
 /**
  * Unpack 64-bit unsigned integer from byte array.
- * @param {Uint8Array} bytes
+ * @param bytes
  */
-function decodeUint64LE(bytes) {
+function decodeUint64LE(bytes: Uint8Array) {
   warnPrecision();
 
   const byteLen = bytes.byteLength;
@@ -37,9 +37,9 @@ function decodeUint64LE(bytes) {
 
 /**
  * Unpack 64-bit signed integer from byte array.
- * @param {Uint8Array} bytes
+ * @param bytes
  */
-function decodeInt64LE(bytes) {
+function decodeInt64LE(bytes: Uint8Array) {
   warnPrecision();
 
   const byteLen = bytes.byteLength;
@@ -63,10 +63,10 @@ function decodeInt64LE(bytes) {
 
 /**
  * Unpack typed array from byte array.
- * @param {Uint8Array} bytes
- * @param {ArrayConstructor} ArrayType - Desired output array type
+ * @param bytes
+ * @param ArrayType - Desired output array type
  */
-function decodeNativeArray(bytes, ArrayType) {
+function decodeNativeArray(bytes: Uint8Array, ArrayType: ArrayConstructor) {
   const byteLen = bytes.byteLength;
   const offset = bytes.byteOffset;
   const buffer = bytes.buffer.slice(offset, offset + byteLen);
@@ -100,10 +100,10 @@ const conversionArrayTypes = {
 
 /**
  * Handle CBOR typed array tags during decoding.
- * @param {Uint8Array} data
- * @param {Number} tag
+ * @param data
+ * @param tag
  */
-export default function cborTypedArrayTagger(data, tag) {
+export default function cborTypedArrayTagger(data: Uint8Array, tag: number) {
   if (tag in nativeArrayTypes) {
     const arrayType = nativeArrayTypes[tag];
     return decodeNativeArray(data, arrayType);

src/util/decompressPng.js renamed to src/util/decompressPng.ts

@@ -5,20 +5,19 @@
 
 import pngparse from "pngparse";
 
-/**
- * @callback decompressPngCallback
- * @param data - The uncompressed data.
- */
 /**
  * If a message was compressed as a PNG image (a compression hack since
  * gzipping over WebSockets * is not supported yet), this function decodes
  * the "image" as a Base64 string.
  *
  * @private
  * @param data - An object containing the PNG data.
- * @param {decompressPngCallback} callback - Function with the following params:
+ * @param callback - Function with the following params:
  */
-export default function decompressPng(data, callback) {
+export default function decompressPng(
+  data: string,
+  callback: (data: unknown) => void,
+) {
   const buffer = new Buffer(data, "base64");
 
   pngparse.parse(buffer, function (err, data) {

src/util/shim/decompressPng.js renamed to src/util/shim/decompressPng.ts

@@ -3,20 +3,19 @@
  * @author Graeme Yeates - github.com/megawac
  */
 
-/**
- * @callback decompressPngCallback
- * @param data - The uncompressed data.
- */
 /**
  * If a message was compressed as a PNG image (a compression hack since
  * gzipping over WebSockets * is not supported yet), this function places the
  * "image" in a canvas element then decodes the * "image" as a Base64 string.
  *
  * @private
- * @param data - An object containing the PNG data.
- * @param {decompressPngCallback} callback - Function with the following params:
+ * @param data - A string containing the PNG data.
+ * @param callback - Function with the following params:
  */
-export default function decompressPng(data, callback) {
+export default function decompressPng(
+  data: string,
+  callback: (data: unknown) => void,
+) {
   // Uncompresses the data before sending it through (use image/canvas to do so).
   const image = new Image();
   // When the image loads, extracts the raw data (JSON message).