Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.95 KB

README.md

File metadata and controls

33 lines (26 loc) · 1.95 KB
Raw

rdf-parser-csvw

build status npm version

A CSV on the Web parser with RDF/JS Stream interface.

Usage

The package exports the parser as a class, so an instance must be created before it can be used. The .import method, as defined in the RDF/JS specification, must be called to do the actual parsing. It expects a stream of strings. The method will return a stream which emits the parsed quads.

The constructor accepts an options object with the following optional keys:

  • metadata: Use the metadata to convert the CSV to RDF. The metadata must be given as a Dataset using the CSV on the Web ontology. This options is required.
  • baseIRI: Use the IRI to create Named Nodes. The value must be a String. This options is required.
  • factory: Use an alternative RDF/JS data factory. By default the reference implementation us used.
  • timezone: Use an alternative timezone to parse date and time values. The value must be given as a String as defined in the Luxon documentation. By default local will be used.
  • relaxColumnCount: Don't throw an error if a row has a column count which doesn't match the headers column coun.
  • skipLinesWithError: Skip lines with error instead of throwing an error and stop parsing. This is mainly useful for debugging and should not be used in production environments.

It's also possible to pass options as second argument to the .import method. The options from the constructor and the .import method will be merged together.