index.d.ts 1.0 KB

1234567891011121314151617181920212223242526272829303132333435
  1. /// <reference types="node" />
  2. /**
  3. * These definitions were written by BendingBender (https://github.com/BendingBender)
  4. */
  5. export = crc32;
  6. declare function crc32(input: string | Buffer, partialCrc?: Buffer | number): Buffer;
  7. declare namespace crc32 {
  8. /**
  9. * Convenience method that returns a signed int instead of a `Buffer`.
  10. *
  11. * @example
  12. * import crc32 = require('buffer-crc32');
  13. *
  14. * // works with buffers
  15. * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
  16. * crc32.signed(buf); // -> -1805997238
  17. */
  18. function signed(buffer: string | Buffer, partialCrc?: Buffer | number): number;
  19. /**
  20. * Convenience method that returns an unsigned int instead of a `Buffer`.
  21. *
  22. * @example
  23. * import crc32 = require('buffer-crc32');
  24. *
  25. * // works with buffers
  26. * const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
  27. * crc32.unsigned(buf); // -> 2488970058
  28. */
  29. function unsigned(buffer: string | Buffer, partialCrc?: Buffer | number): number;
  30. }