References

parsers

summary
public	C AutoWARCParser Parses a WARC file automatically detecting if it is gzipped.
public	C GzipDetector Utility class that provides the means to detect if a file is gzipped or not
public	C WARCGzParser Parse a WARC.gz file
public	C WARCParser Parse a WARC file
public	C WARCStreamTransform Transforms a WARC file ReadStream into its individual WARCRecords
public	F async * recordIterator(warcStream: ReadStream \| Gunzip): AsyncIterator<WARCRecord> Creates async iterator that yields WARCRecords given a readable stream of a WARC file

summary
public	C CapturedRequest Represents A Unique Request And Response Chain As Made By A Page Consolidates The Modification Of HTTP/2 Into HTTP/1.1 Provides Utility Functionality For Serialization To WARC
public	C CDPRequestInfo Represents a request and response
public	C CRIExtraRequestCapturer chrome-remote-interface-extra request capturer
public	C ElectronRequestCapturer The remote electron request chapturer to use along side ElectronWARCGenerator See the documentation for attach and maybeNetworkMessage for setup information Controlled via startCapturing and stopCapturing
public	C PuppeteerRequestCapturer Puppeteer Request Capturer
public	C PuppeteerCDPRequestCapturer
public	C RemoteChromeRequestCapturer The remote chrome request chapturer to use along side RemoteChromeWARCGenerator The only setup required is to pass the chrome-remote-interface Network object Controlled via startCapturing and stopCapturing
public	C RequestHandler Class Responsible For Managing The Captured Request / Responses For A Page
public	V CDPRequestInfo: CDPRequestInfo
public	V CRIExtraCapturer: CRIExtraRequestCapturer
public	V CapturedRequest: CapturedRequest
public	V ElectronCapturer: ElectronRequestCapturer
public	V PuppeteerCDPCapturer: PuppeteerCDPRequestCapturer
public	V PuppeteerCapturer: PuppeteerRequestCapturer
public	V RemoteChromeCapturer: RemoteChromeRequestCapturer
public	V RequestHandler: RequestHandler

summary
public	C ElectronGetResError Electron debugger errors passed to the callback are plain objects not Errors but contain information concerning the error.
public	F ensureWARCFilename(filename: string, gzipping: boolean): string Ensure that the supplied name for the WARC is correct
public	F getResBodyElectron(requestId: string, wcDebugger: Object): Promise<Buffer> Electron requires the use of the debugger to retrieve the requests response body
public	F stringifyHeaders(headers: Object): string Converts an HTTP headers object into its string representation
public	F stringifyRequestHeaders(headers: Object, host: string): string Converts an HTTP request headers object into its string representation
public	F isEmptyPlainObject(object: Object): boolean Test to see if a `plain object` is empty
public	V ElectronGetResError: *
public	V constants: {canReplayProtocols: Set<string>, SPACE: string, H2Method: string, HTTP1D1: string, DASH: string, H2path: string}
public	V ensureWARCFilename: *
public	V getResBodyElectron: *
public	V isEmptyPlainObject: *
public	V stringifyHeaders: *
public	V stringifyRequestHeaders: *

summary
public	C RecordBuilder Progressively builds warc records by consuming the file line by line
public	C WARCRecord WARC record class.
public	C ContentParser Utility class for parsing parts of WARC records
public	V ContentParser: ContentParser
public	V RecordBuilder: RecordBuilder
public	V WARCRecord: WARCRecord
public	T RequestHTTP: Object
public	T ResponseHTTP: Object

summary
public	C CRIExtraWARCGenerator WARC Generator for use with puppeteer
public	C ElectronWARCGenerator WARC Generator for use with Electron
public	C PuppeteerWARCGenerator WARC Generator for use with puppeteer
public	C PuppeteerCDPWARCGenerator WARC Generator for use with puppeteer
public	C RemoteChromeWARCGenerator WARC Generator for use with chrome-remote-interface
public	C RequestLibWARCGenerator WARC Generator for use with request
public	C WARCWriterBase Base class used for writing to the WARC
public	V CRIExtraWARCGenerator: CRIExtraWARCGenerator
public	V ElectronWARCWriter: ElectronWARCGenerator
public	V PuppeteerCDPWARCGenerator: PuppeteerCDPWARCGenerator
public	V PuppeteerWARCGenerator: PuppeteerWARCGenerator
public	V RemoteChromeWARCWriter: RemoteChromeWARCGenerator
public	V WARCWriterBase: WARCWriterBase
public	T WARCInfoHeader: Object
public	T WARCMetadataHeader: Object
public	T WARCRequestHeader: Object
public	T WARCResponseHeader: Object
public	T Metadata: Object
public	T WARCFileOpts: Object
public	T WARCGenOpts: Object
public	T WARCInitOpts: Object

Directories