Interface Car

The Car interface provides operations for importing and exporting Car files from Helia's underlying blockstore.

interface Car {
    export(
        root:
            | CID<unknown, number, number, Version>
            | CID<unknown, number, number, Version>[],
        options?: ExportCarOptions,
    ): AsyncGenerator<Uint8Array<ArrayBufferLike>, void, undefined>;
    import(
        reader: Pick<CarReader, "blocks">,
        options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
    ): Promise<void>;
}

Index

Methods

Methods

export

export(
    root:
        | CID<unknown, number, number, Version>
        | CID<unknown, number, number, Version>[],
    options?: ExportCarOptions,
): AsyncGenerator<Uint8Array<ArrayBufferLike>, void, undefined>
Returns an AsyncGenerator that yields CAR file bytes.
Parameters
- root: CID<unknown, number, number, Version> | CID<unknown, number, number, Version>[]
- Optionaloptions: ExportCarOptions
Returns AsyncGenerator<Uint8Array<ArrayBufferLike>, void, undefined>
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.export(cid)) {
  // store or send `buf` somewhere
}
```
- Defined in packages/car/src/index.ts:256

import

import(
reader: Pick<CarReader, "blocks">,
options?: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>,
): Promise<void>
Add all blocks in the passed CarReader to the blockstore.
Parameters
- reader: Pick<CarReader, "blocks">
- Optionaloptions: AbortOptions & ProgressOptions<PutManyBlocksProgressEvents>
Returns Promise<void>
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)
```
- Defined in packages/car/src/index.ts:234