https://github.com/n0tan3rd/node-cdxj

Parse CDXJ(https://github.com/oduwsdl/ORS/wiki/CDXJ) files with node.js
https://github.com/n0tan3rd/node-cdxj

cdxj web-archives webarchive webarchiving

Last synced: 10 months ago
JSON representation

Parse CDXJ(https://github.com/oduwsdl/ORS/wiki/CDXJ) files with node.js

• Host: GitHub
• URL: https://github.com/n0tan3rd/node-cdxj
• Owner: N0taN3rd
• License: mit
• Created: 2017-05-18T04:45:08.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-20T02:04:58.000Z (almost 9 years ago)
• Last Synced: 2025-02-25T16:13:44.071Z (over 1 year ago)
• Topics: cdxj, web-archives, webarchive, webarchiving
• Language: JavaScript
• Homepage:
• Size: 128 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# node-cdxj

Read cdxj files produced by [Pywb](https://github.com/ikreymer/pywb) using node.js.

Run `npm install cdxj` or `yarn add cdxj` to get started

[![npm Package](https://img.shields.io/npm/v/cdxj.svg?style=flat-square)](https://www.npmjs.com/package/cdxj)

## Example usage

### Example 1

```js

const CDXJReader = require('cdxj')

async function getMeSomeCDXJ () {

  let cdxj = await CDXJReader.readCDXJ('')

  cdxj.forEach(cdxjEntry => {

     console.log(`The URL in surt form for this entry is: ${cdxjEntry.surt}`)

     console.log(`The raw datetime for this entry is: ${cdxjEntry.dt}`)

     console.log(`The json data for this entry is: ${cdxjEntry.json}`)

  })

}

```

### Example 2

```js

const CDXJReader = require('cdxj')

const cdxjStream = CDXJReader.createReadStream('')

cdxjStream.on('data', cdxjEntry => { 

  console.log(cdxjEntry) 

})

```

## API

Full API documentation available at [n0tan3rd.github.io/node-cdxj](https://n0tan3rd.github.io/node-cdxj/)

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)