package
streaming parser for the ZIM aka OpenZIM file format http://www.openzim.org/wiki/ZIM_file_format
npm install zimmerGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
streaming/random access parser for the ZIM aka OpenZIM file format http://www.openzim.org/wiki/ZIM_file_format
requires the lzma-native native dependency for xz decompression (no pure js version available as of 2017)
var zimmer = require('zimmer')
zimmer.readHeader(fd, function (err, header) {})
var readable = zimmer.createOffsetStream(filename, start, num, opts)
var readable = zimmer.createClusterPointerStream(filename, header, opts)
var readable = zimmer.createEntryPointerStream(filename, header, opts)
zimmer.readDirectoryEntry(filename, fd, header, {index: 1}, function (err, entry) { })
zimmer.readCluster(filename, fd, header, {index: entry.cluster}, function (err, cluster) { })$ npm install zimmer -g
$ zimmer
zimmer zim parser - usage
zimmer <filename> - streams all entry metadata + data to stdout'
zimmer extract <filename> <out> - extracts and writes files to output dir
zimmer header <num> <filename> - reads zim header
zimmer entries <filename> - streams all entry metadata to stdout
zimmer entry <num> <filename> - reads specific entry data by index
zimmer clusters <filename> - streams all cluster metadata to stdout
zimmer cluster <num> <filename> - reads specific cluster data by indexread a single entry's data by index:
var filename = 'data.zim'
var index = 1
fs.open(filename, 'r', function (err, file) {
if (err) throw err
zim.readHeader(file, function(err, header) {
if (err) throw err
zim.readDirectoryEntry(filename, file, header, {index: index}, function (err, entry) {
if (err) throw err
zim.readCluster(filename, file, header, {index: entry.cluster}, function (err, cluster) {
if (err) throw err
var contents = cluster.blobs[entry.blob]
// contents is a buffer
})
read all entry data as a stream and pipe as ndjson to stdout
var pump = require('pump')
var ndjson = require('ndjson')
var filename = 'data.zim'
fs.open(filename, 'r', function (err, file) {
if (err) throw err
zim.readHeader(file, function(err, header) {
if (err) throw err
var pointers = zim.createEntryPointerStream(filename, header)
var reader = through.obj(function(entry, enc, cb) {
zim.readDirectoryEntry(filename, file, header, entry, function (err, entry) {
maxogden
max@maxogden.com
Estimated unpacked size across 27 packages.
8.9 MB
Includes dependencies.
8.0.6
^1.5.1
2.0.0