index.d.ts 3.1 KB

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