extract-base-iterator
Version:
Base iterator for extract iterators like tar-iterator and zip-iterator
36 lines (35 loc) • 948 B
text/typescript
/**
* EntryStream - Simple readable stream for entry content
*
* Extends Readable to emit 'data', 'end', 'error' events.
* Node 0.8 compatible via readable-stream polyfill.
*
* This base class is designed to be used by:
* - zip-iterator
* - 7z-iterator
* - tar-iterator
* - Any other archive iterator library
*/
import Stream from 'stream';
declare let ReadableBase: typeof Stream.Readable;
/**
* Base stream class for archive entry content.
* Can be extended for special entry types like sparse files.
*/
export default class EntryStream extends ReadableBase {
protected _ended: boolean;
/**
* Signal end of stream by pushing null
*/
end(): void;
/**
* Check if stream has ended
*/
get ended(): boolean;
/**
* Required by Readable - called when consumer wants data.
* Data is pushed externally via push(), nothing to do here.
*/
_read(_size: number): void;
}
export {};