From 8a1e533638073f6c036803aaa77d8bbcc1862877 Mon Sep 17 00:00:00 2001
From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
Date: Thu, 8 Jun 2023 11:09:04 -0700
Subject: [PATCH] fix: fs already defined in example
Fixes non-compileable code example where we set both `node:fs` import and `unixfs(helia)` to a variable `fs`.
---
packages/car/src/index.ts | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/packages/car/src/index.ts b/packages/car/src/index.ts
index 6381227..8640a4b 100644
--- a/packages/car/src/index.ts
+++ b/packages/car/src/index.ts
@@ -15,7 +15,7 @@
* import { car } from '@helia/car'
* import { CarWriter } from '@ipld/car'
* import { Readable } from 'node:stream'
- * import fs from 'node:fs'
+ * import nodeFs from 'node:fs'
*
* const helia = createHelia({
* // ... helia config
@@ -30,7 +30,7 @@
* const { writer, out } = await CarWriter.create(cid)
*
* // `out` needs to be directed somewhere, see the @ipld/car docs for more information
- * Readable.from(out).pipe(fs.createWriteStream('example.car'))
+ * Readable.from(out).pipe(nodeFs.createWriteStream('example.car'))
*
* // write the DAG behind `cid` into the writer
* await c.export(cid, writer)
@@ -44,14 +44,14 @@
* import { car } from '@helia/car'
* import { CarReader } from '@ipld/car'
* import { Readable } from 'node:stream'
- * import fs from 'node:fs'
+ * import nodeFs from 'node:fs'
*
* const helia = createHelia({
* // ... helia config
* })
*
* // import the car
- * const inStream = fs.createReadStream('example.car')
+ * const inStream = nodeFs.createReadStream('example.car')
* const reader = await CarReader.fromIterable(inStream)
*
* await c.import(reader)