@helia/car

Import/export car files from Helia

About

@helia/car provides import and export methods to read/write Car files to Helia's blockstore.

See the Car interface for all available operations.

By default it supports dag-pb, dag-cbor, dag-json and raw CIDs, more esoteric DAG walkers can be passed as an init option.

Example - Exporting a DAG as a CAR file

import { createHelia } from 'helia'
import { car } from '@helia/car'
import { CID } from 'multiformats/cid'
import nodeFs from 'node:fs'

const helia = await createHelia()
const cid = CID.parse('QmFoo...')

const c = car(helia)
const out = nodeFs.createWriteStream('example.car')

for await (const buf of c.stream(cid)) {
  out.write(buf)
}

out.end()
Copy

Example - Exporting a part of a UnixFS DAG as a CAR file

import { createHelia } from 'helia'
import { car, UnixFSPath } from '@helia/car'
import { CID } from 'multiformats/cid'
import nodeFs from 'node:fs'

const helia = await createHelia()
const cid = CID.parse('QmFoo...')

const c = car(helia)
const out = nodeFs.createWriteStream('example.car')

for await (const buf of c.stream(cid, {
  traversal: new UnixFSPath('/foo/bar/baz.txt')
})) {
  out.write(buf)
}

out.end()
Copy

Example - Importing all blocks from a CAR file

import { createHelia } from 'helia'
import { unixfs } from '@helia/unixfs'
import { car } from '@helia/car'
import { CarReader } from '@ipld/car'
import { Readable } from 'node:stream'
import nodeFs from 'node:fs'

const helia = await createHelia({
  // ... helia config
})

// import the car
const inStream = nodeFs.createReadStream('example.car')
const reader = await CarReader.fromIterable(inStream)

const c = car(helia)
await c.import(reader)
Copy

Install

$ npm i @helia/car
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as HeliaCar in the global namespace.

<script src="https://unpkg.com/@helia/car/dist/index.min.js"></script>
Copy

API Docs

• https://ipfs.github.io/helia/modules/_helia_car.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.