@types/buffer-crc32 - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

buffer-crc32/index.d.ts

@@ -10,7 +10,49 @@ // Type definitions for buffer-crc32 0.2
 
+/**
+ * crc32 that works with binary data and fancy character sets.
+ *
+ * @example
+ * import crc32 = require('buffer-crc32');
+ *
+ * // works with buffers
+ * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
+ * crc32(buf); // -> <Buffer 94 5a ab 4a>
+ *
+ * // will cast to buffer if given a string, so you can
+ * // directly use foreign characters safely
+ * crc32('自動販売機'); // -> <Buffer cb 03 1a c5>
+ *
+ * // and works in append mode too
+ * let partialCrc = crc32('hey');
+ * partialCrc = crc32(' ', partialCrc);
+ * partialCrc = crc32('sup', partialCrc);
+ * partialCrc = crc32(' ', partialCrc);
+ * const finalCrc = crc32('bros', partialCrc); // -> <Buffer 47 fa 55 70>
+ */
 declare function crc32(input: string | Buffer, partialCrc?: Buffer | number): Buffer;
 
 declare namespace crc32 {
+    /**
+     * Convenience method that returns a signed int instead of a `Buffer`.
+     *
+     * @example
+     * import crc32 = require('buffer-crc32');
+     *
+     * // works with buffers
+     * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
+     * crc32.signed(buf); // -> -1805997238
+     */
     function signed(buffer: string | Buffer, partialCrc?: Buffer | number): number;
+
+    /**
+     * Convenience method that returns an unsigned int instead of a `Buffer`.
+     *
+     * @example
+     * import crc32 = require('buffer-crc32');
+     *
+     * // works with buffers
+     * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
+     * crc32.unsigned(buf); // -> 2488970058
+     */
     function unsigned(buffer: string | Buffer, partialCrc?: Buffer | number): number;
 }

buffer-crc32/package.json

 {
     "name": "@types/buffer-crc32",
-    "version": "0.2.1",
+    "version": "0.2.2",
     "description": "TypeScript definitions for buffer-crc32",
@@ -25,4 +25,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/buffer-crc32",
     },
-    "typesPublisherContentHash": "1cdfef91bca583f9717263482d5997bc6b2c4518e48679f577c65da6ba71e62c",
+    "typesPublisherContentHash": "a827197392591bdef5d81f69bed17114e20734e374e163ef02d49050c11bfd18",
     "typeScriptVersion": "4.2"
 }

buffer-crc32/README.md

@@ -20,6 +20,48 @@ # Installation
 
+/**
+ * crc32 that works with binary data and fancy character sets.
+ *
+ * @example
+ * import crc32 = require('buffer-crc32');
+ *
+ * // works with buffers
+ * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
+ * crc32(buf); // -> <Buffer 94 5a ab 4a>
+ *
+ * // will cast to buffer if given a string, so you can
+ * // directly use foreign characters safely
+ * crc32('自動販売機'); // -> <Buffer cb 03 1a c5>
+ *
+ * // and works in append mode too
+ * let partialCrc = crc32('hey');
+ * partialCrc = crc32(' ', partialCrc);
+ * partialCrc = crc32('sup', partialCrc);
+ * partialCrc = crc32(' ', partialCrc);
+ * const finalCrc = crc32('bros', partialCrc); // -> <Buffer 47 fa 55 70>
+ */
 declare function crc32(input: string | Buffer, partialCrc?: Buffer | number): Buffer;
 
 declare namespace crc32 {
+    /**
+     * Convenience method that returns a signed int instead of a `Buffer`.
+     *
+     * @example
+     * import crc32 = require('buffer-crc32');
+     *
+     * // works with buffers
+     * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
+     * crc32.signed(buf); // -> -1805997238
+     */
     function signed(buffer: string | Buffer, partialCrc?: Buffer | number): number;
+
+    /**
+     * Convenience method that returns an unsigned int instead of a `Buffer`.
+     *
+     * @example
+     * import crc32 = require('buffer-crc32');
+     *
+     * // works with buffers
+     * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
+     * crc32.unsigned(buf); // -> 2488970058
+     */
     function unsigned(buffer: string | Buffer, partialCrc?: Buffer | number): number;
@@ -31,3 +73,3 @@ }
 ### Additional Details
- * Last updated: Sun, 04 Dec 2022 11:03:38 GMT
+ * Last updated: Sun, 04 Dec 2022 18:03:04 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
@@ -34,0 +76,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

6578

71.75%

Lines of code

52

372.73%

Number of lines in readme file

78

116.67%

No dependency changes