public class | source

CDXJReader

CDXJReader that provides two means to read a cdxj file

const cdxjStream = CDXJReader.createReadStream('<path-to-cdxj-file>')
cdxjStream.on('data', cdxjEntry => { console.log(cdxjEntry) })

Static Method Summary

Static Public Methods
public static	createReadStream(cdxjPath: string): ReadableStream<CDXJEntry> Parse a cdxj file.
public static	readCDXJ(cdxjPath: string): Promise<CDXJEntry[], Error> Read a cdxj file in its entirety

Parse a cdxj file. Returns a Readable Stream which emits CDXJEntrys

Name	Type	Attribute	Description
cdxjPath	string		the path to the cdxj file to parse, supports ~ paths

Read a cdxj file in its entirety

Name	Type	Attribute	Description
cdxjPath	string		the path to the cdxj file to parse, supports ~ paths