Home Reference Source

Typedef

Static Public Summary
public	Metadata: Object
public	RequestHTTP: Object
public	ResponseHTTP: Object
public	WARCFileOpts: Object
public	WARCGenOpts: Object
public	WARCInfoHeader: Object
public	WARCInitOpts: Object
public	WARCMetadataHeader: Object
public	WARCRequestHeader: Object
public	WARCResponseHeader: Object

Static Public

public Metadata: Object source

Properties:

Name	Type	Attribute	Description
targetURI	string		The target URI for the metadata record
content	string \| Buffer	optional nullable: true	The contents of the metadata record

public RequestHTTP: Object source

Properties:

Name	Type	Attribute	Description
requestLine	string	nullable: true	The HTTP request line
path	string	nullable: true	The path of the request
method	string	nullable: true	The HTTP method used
httpVersion	string	nullable: true	The HTTP version
headers	Object	nullable: true	The parsed headers

public ResponseHTTP: Object source

Properties:

Name	Type	Attribute	Description
statusLine	string	nullable: true	The HTTP response line
statusCode	string	nullable: true	The response code
statusReason	string	nullable: true	The status reason
httpVersion	string	nullable: true	The HTTP version
headers	Object	nullable: true	The parsed headers

public WARCFileOpts: Object source

Properties:

Name	Type	Attribute	Description
appending	boolean	optional	Should the WARC writer append to an existing warc?
gzip	boolean	optional	Should the WARC writer generate gziped records?

public WARCGenOpts: Object source

Properties:

Name	Type	Attribute	Description
pages	string \| Array<string>		The URL of the page this WARC contains or an Array of URLs for the pages this WARC contains. Used to write a WARC Info record containing Webrecorder Player compatible bookmark list
warcOpts	WARCInitOpts		Options for the writing of the WARC file
winfo	Object \| Buffer \| string	optional	Optional contents for the WARC info record
metadata	Metadata	optional	Optional metadata contents

public WARCInfoHeader: Object source

Properties:

Name	Type	Attribute	Description
date	string		The date value for WARC-Date
fileName	string	optional nullable: true	The name of the warc file
targetURI	string	optional nullable: true	The target URI for the record
rid	string		The id of the record
len	number		The length of the records content

public WARCInitOpts: Object source

Properties:

Name	Type	Attribute	Description
warcPath	string		Path the warc file to be written to
appending	boolean	optional	Should the WARC writer append to an existing warc?
gzip	boolean	optional	Should the WARC writer generate gziped records?

public WARCMetadataHeader: Object source

Properties:

Name	Type	Attribute	Description
targetURI	string		The URI the records are for
now	string		The date value for WARC-Date
concurrentTo	string		The record id this metadata record is associated with
rid	string		The record id of this record
len	number		The length of this records content
wid	string	nullable: true	The record id of the Warcinfo record

public WARCRequestHeader: Object source

Properties:

Name	Type	Attribute	Description
targetURI	string		The URI the record is for
now	string		The date value for WARC-Date
concurrentTo	string		The record id of the record this record associated with
rid	string		The record id of this record
len	number		The length of this records content
wid	string	nullable: true	The record id of the Warcinfo record

public WARCResponseHeader: Object source

Properties:

Name	Type	Attribute	Description
targetURI	string		The URI the record is for
now	string		The date value for WARC-Date
rid	string		The record id of this record
len	number		The length of this records content
wid	string	nullable: true	The record id of the Warcinfo record