import WARCParser from 'node-warc/lib/parsers/warcParser.js'

public class | source

WARCParser

Extends:

EventEmitter → WARCParser

Parse a WARC file

Example:

 const parser = new WARCParser('<path-to-warcfile>')
 parser.on('record', record => { console.log(record) })
 parser.on('done', () => { console.log('done') })
 parser.on('error', error => { console.error(error) })
 parser.start()

 const parser = new WARCParser()
 parser.on('record', record => { console.log(record) })
 parser.on('done', () => { console.log('done') })
 parser.on('error', error => { console.error(error) })
 parser.parseWARC('<path-to-warcfile>')

 // requires node >= 10
 for await (const record of new WARCParser('<path-to-warcfile>')) {
   console.log(record)
 }

Constructor Summary

Public Constructor
public	constructor(wp: string) Create a new WARCParser

Member Summary

Public Members
public	[Symbol.asyncIterator]: AsyncIterator<WARCRecord>: *

Private Members
private	_parsing: boolean
private	_wp: string

Method Summary

Public Methods
public	parseWARC(wp: string): boolean Alias for start except that you can supply the path to the WARC file to be parsed if one was not supplied via the constructor or to parse another WARC file.
public	start(): boolean Begin parsing the WARC file.

Private Methods
private	_onEnd() Callback for the read stream end event
private	_onError(error: Error) Callback for the read stream error event
private	_onRecord(record: WARCRecord) Callback for the read stream data event

Public Constructors

public constructor(wp: string) source

Create a new WARCParser

Params:

Name	Type	Attribute	Description
wp	string	optional nullable: true	path to the warc file to be parsed

Public Members

public [Symbol.asyncIterator]: AsyncIterator<WARCRecord>: * source

Return:

AsyncIterator<WARCRecord>

Private Members

private _parsing: boolean source

private _wp: string source

Public Methods

public parseWARC(wp: string): boolean source

Alias for start except that you can supply the path to the WARC file to be parsed if one was not supplied via the constructor or to parse another WARC file. If the path to WARC file to be parsed was supplied via the constructor and you supply a different path to this method. It will override the one supplied via the constructor

Params:

Name	Type	Attribute	Description
wp	string	optional nullable: true	path to the WARC file to be parsed

Return:

boolean

indication if the parser has begun or is currently parsing a WARC file

Throw:

Error

if the path to the WARC file is null or undefined or another error occurred

public start(): boolean source

Begin parsing the WARC file. Once the start method has been called the parser will begin emitting

Return:

boolean

indication if the parser has begun or is currently parsing a WARC file

true: indicates the parser has begun parsing the WARC file true
false: indicated the parser is currently parsing a WARC file

Emit:

record	emitted when the parser has parsed a full record, the argument supplied to the listener will be the parsed record
done	emitted when the WARC file has been completely parsed, the argument supplied to the listener will be last record
error	emitted if an exception occurs, the argument supplied to the listener will be the error that occurred.

Throw:

Error

if the path to the WARC file is null or undefined or another error occurred

Private Methods

private _onEnd() source

Callback for the read stream end event

private _onError(error: Error) source

Callback for the read stream error event

Params:

Name	Type	Attribute	Description
error	Error

private _onRecord(record: WARCRecord) source

Callback for the read stream data event

Params:

Name	Type	Attribute	Description
record	WARCRecord