index.d.ts 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. import { Buffer } from 'buffer';
  2. import { Minipass } from 'minipass';
  3. import * as realZlib from 'zlib';
  4. export { constants } from './constants.js';
  5. declare const _superWrite: unique symbol;
  6. export declare class ZlibError extends Error {
  7. code?: string;
  8. errno?: number;
  9. constructor(err: NodeJS.ErrnoException | Error);
  10. get name(): string;
  11. }
  12. declare const _flushFlag: unique symbol;
  13. export type ChunkWithFlushFlag = Minipass.ContiguousData & {
  14. [_flushFlag]?: number;
  15. };
  16. export type ZlibBaseOptions = Minipass.Options<Minipass.ContiguousData> & {
  17. flush?: number;
  18. finishFlush?: number;
  19. fullFlushFlag?: number;
  20. };
  21. export type ZlibMode = 'Gzip' | 'Gunzip' | 'Deflate' | 'Inflate' | 'DeflateRaw' | 'InflateRaw' | 'Unzip';
  22. export type ZlibHandle = realZlib.Gzip | realZlib.Gunzip | realZlib.Deflate | realZlib.Inflate | realZlib.DeflateRaw | realZlib.InflateRaw;
  23. export type BrotliMode = 'BrotliCompress' | 'BrotliDecompress';
  24. declare abstract class ZlibBase extends Minipass<Buffer, ChunkWithFlushFlag> {
  25. #private;
  26. get sawError(): boolean;
  27. get handle(): ZlibHandle | undefined;
  28. get flushFlag(): number;
  29. constructor(opts: ZlibBaseOptions, mode: ZlibMode | BrotliMode);
  30. close(): void;
  31. reset(): any;
  32. flush(flushFlag?: number): void;
  33. end(cb?: () => void): this;
  34. end(chunk: ChunkWithFlushFlag, cb?: () => void): this;
  35. end(chunk: ChunkWithFlushFlag, encoding?: Minipass.Encoding, cb?: () => void): this;
  36. get ended(): boolean;
  37. [_superWrite](data: Buffer & {
  38. [_flushFlag]?: number;
  39. }): boolean;
  40. write(chunk: ChunkWithFlushFlag, cb?: () => void): boolean;
  41. write(chunk: ChunkWithFlushFlag, encoding?: Minipass.Encoding, cb?: () => void): boolean;
  42. }
  43. export type ZlibOptions = ZlibBaseOptions & {
  44. level?: number;
  45. strategy?: number;
  46. };
  47. export declare class Zlib extends ZlibBase {
  48. #private;
  49. constructor(opts: ZlibOptions, mode: ZlibMode);
  50. params(level: number, strategy: number): void;
  51. }
  52. export declare class Deflate extends Zlib {
  53. constructor(opts: ZlibOptions);
  54. }
  55. export declare class Inflate extends Zlib {
  56. constructor(opts: ZlibOptions);
  57. }
  58. export type GzipOptions = ZlibOptions & {
  59. portable?: boolean;
  60. };
  61. export declare class Gzip extends Zlib {
  62. #private;
  63. constructor(opts: GzipOptions);
  64. [_superWrite](data: Buffer & {
  65. [_flushFlag]?: number;
  66. }): boolean;
  67. }
  68. export declare class Gunzip extends Zlib {
  69. constructor(opts: ZlibOptions);
  70. }
  71. export declare class DeflateRaw extends Zlib {
  72. constructor(opts: ZlibOptions);
  73. }
  74. export declare class InflateRaw extends Zlib {
  75. constructor(opts: ZlibOptions);
  76. }
  77. export declare class Unzip extends Zlib {
  78. constructor(opts: ZlibOptions);
  79. }
  80. export declare class Brotli extends ZlibBase {
  81. constructor(opts: ZlibOptions, mode: BrotliMode);
  82. }
  83. export declare class BrotliCompress extends Brotli {
  84. constructor(opts: ZlibOptions);
  85. }
  86. export declare class BrotliDecompress extends Brotli {
  87. constructor(opts: ZlibOptions);
  88. }
  89. //# sourceMappingURL=index.d.ts.map