Skip to content

Commit

Permalink
Remove redundant docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kibertoad committed Feb 3, 2024
1 parent 5807b36 commit 7a8551c
Showing 1 changed file with 0 additions and 21 deletions.
21 changes: 0 additions & 21 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,6 @@

export = crc32;

/**
* 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 {
Expand Down

0 comments on commit 7a8551c

Please sign in to comment.