Function

Static Public Summary
public	ensureWARCFilename(filename: string, gzipping: boolean): string Ensure that the supplied name for the WARC is correct
public	getResBodyElectron(requestId: string, wcDebugger: Object): Promise<Buffer> Electron requires the use of the debugger to retrieve the requests response body
public	isEmptyPlainObject(object: Object): boolean Test to see if a `plain object` is empty
public	async * recordIterator(warcStream: ReadStream \| Gunzip): AsyncIterator<WARCRecord> Creates async iterator that yields WARCRecords given a readable stream of a WARC file
public	stringifyHeaders(headers: Object): string Converts an HTTP headers object into its string representation
public	stringifyRequestHeaders(headers: Object, host: string): string Converts an HTTP request headers object into its string representation

Static Public

import ensureWARCFilename from 'node-warc/lib/utils/ensureWARCFilename.js'

Ensure that the supplied name for the WARC is correct

import getResBodyElectron from 'node-warc/lib/utils/getResBodyElectron.js'

Electron requires the use of the debugger to retrieve the requests response body

Name	Type	Attribute	Description
requestId	string		the request to fetch the response body for
wcDebugger	Object		the Electron debugger to use to get the response body

body - the response body as a node buffer

rejects if the error parameter to the callback was set

import isEmptyPlainObject from 'node-warc/lib/utils/isEmptyPlainObject.js'

Test to see if a plain object is empty

Name	Type	Attribute	Description
object	Object	nullable: true

import recordIterator from 'node-warc/lib/parsers/recordterator.js'

Creates async iterator that yields WARCRecords given a readable stream of a WARC file

Name	Type	Attribute	Description
warcStream	ReadStream \| Gunzip

import {stringifyHeaders} from 'node-warc/lib/utils/headerSerializers.js'

Converts an HTTP headers object into its string representation

Name	Type	Attribute	Description
headers	Object		The HTTP header object to be stringified

import {stringifyRequestHeaders} from 'node-warc/lib/utils/headerSerializers.js'

Converts an HTTP request headers object into its string representation

Name	Type	Attribute	Description
headers	Object		The HTTP headers object for the request
host	string		The host for the request to be used if the HTTP headers object does not contain the Host field