Merge pull request #32721 from BendingBender/byte-range

[byte-range] Add types

types/byte-range/byte-range-tests.ts

@@ -0,0 +1,10 @@
+import byteRange = require('byte-range');
+
+byteRange(1); // $ExpectType [number, number]
+byteRange(1, { signed: false }); // $ExpectType [number, number]
+byteRange.uint8; // $ExpectType [number, number]
+byteRange.uint16; // $ExpectType [number, number]
+byteRange.uint32; // $ExpectType [number, number]
+byteRange.int8; // $ExpectType [number, number]
+byteRange.int16; // $ExpectType [number, number]
+byteRange.int32; // $ExpectType [number, number]

types/byte-range/index.d.ts

@@ -0,0 +1,49 @@
+// Type definitions for byte-range 1.0
+// Project: https://github.com/lukechilds/byte-range#readme
+// Definitions by: BendingBender <https://github.com/BendingBender>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+export = byteRange;
+
+/**
+ * Calculates integer ranges for a given number of bytes.
+ *
+ * @param bytes Number of bytes to return the integer range for. Must be a positive integer.
+ */
+declare function byteRange(bytes: number, options?: byteRange.Options): byteRange.ByteRange;
+
+declare namespace byteRange {
+    /**
+     * Precomputed byte range for an unsigned 8 bit integer.
+     */
+    const uint8: ByteRange;
+    /**
+     * Precomputed byte range for an unsigned 16 bit integer.
+     */
+    const uint16: ByteRange;
+    /**
+     * Precomputed byte range for an unsigned 32 bit integer.
+     */
+    const uint32: ByteRange;
+    /**
+     * Precomputed byte range for an signed 8 bit integer.
+     */
+    const int8: ByteRange;
+    /**
+     * Precomputed byte range for an signed 16 bit integer.
+     */
+    const int16: ByteRange;
+    /**
+     * Precomputed byte range for an signed 32 bit integer.
+     */
+    const int32: ByteRange;
+
+    interface Options {
+        /**
+         * @default false
+         */
+        signed?: boolean;
+    }
+
+    type ByteRange = [number, number];
+}

types/byte-range/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "byte-range-tests.ts"
+    ]
+}

types/byte-range/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }