Interface Car

Store all blocks that make up one or more DAGs in a car file.

Example

import fs from 'node:fs'
import { Readable } from 'stream'
import { createHelia } from 'helia'
import { car } from '@helia/car
import { CID } from 'multiformats/cid'
import pEvent from 'p-event'

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

const c = car(helia)

const byteStream = await c.export(cid)
const output = fs.createWriteStream('example.car')
const eventPromise = pEvent(output, 'end')
Readable.from(byteStream).pipe(output)

await eventPromise
Copy

Add all blocks in the passed CarReader to the blockstore.

Example

import fs from 'node:fs'
import { createHelia } from 'helia'
import { car } from '@helia/car
import { CarReader } from '@ipld/car'

const helia = await createHelia()

const inStream = fs.createReadStream('example.car')
const reader = await CarReader.fromIterable(inStream)

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

Returns an AsyncGenerator that yields CAR file bytes.

Example

import { createHelia } from 'helia'
import { car } from '@helia/car
import { CID } from 'multiformats/cid'

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

const c = car(helia)

for (const buf of c.stream(cid)) {
  // store or send `buf` somewhere
}
Copy