You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 12, 2024. It is now read-only.
refactor: make add only work on single items (#3167)
`ipfs.add` now returns single items only. Where a source would result in multiple items returned, only the last item is returned. As a first pass `ipfs.add` still takes multiple items but only accepting single items is documented and considered supported. In the future it may throw if multiple items are passed.
`ipfs.addAll` retains the previous behaviour of `ipfs.add`.
Examples:
```javascript
const { cid, path, mode, mtime } = await ipfs.add('Hello world')
```
```javascript
const { cid } = await ipfs.add(Uint8Array.from([0, 1, 2]))
```
```javascript
const { cid } = await ipfs.add(fs.createReadStream('/path/to/file.txt'))
```
```javascript
const { cid } = await ipfs.add({
path: '/foo/bar/baz.txt',
content: 'File content'
})
// Creates a DAG with multiple levels of directories.
// The returned cid is the CID for the root directory /foo
// You can retrieve the file content with an IPFS path
for await (const buf of ipfs.cat(`/ipfs/${cid}/bar/baz.txt`)) {
...
}
// Or get the CID of the nested file with ipfs.files.stat
const { cid: fileCid } = await ipfs.files.stat(`/ipfs/${cid}/bar/baz.txt`)
// or ipfs.dag.resolve
const { cid: fileCid } = await ipfs.dag.resolve(`/ipfs/${cid}/bar/baz.txt`)
```
```javascript
// To have `/foo` included in the ipfs path, wrap it in a directory:
const { cid } = await ipfs.add({
path: '/foo/bar/baz.txt',
content: 'File content'
}, {
wrapWithDirectory: true
})
for await (const buf of ipfs.cat(`/ipfs/${cid}/foo/bar/baz.txt`)) {
...
}
```
BREAKING CHANGES:
- `ipfs.add` only works on single items - a Uint8Array, a String, an AsyncIterable<Uint8Array> etc
- `ipfs.addAll` works on multiple items
As an object, `secs` is the number of seconds since (positive) or before (negative) the Unix Epoch began and `nsecs` is the number of nanoseconds since the last full second.
152
+
153
+
As an array of numbers, it must have two elements, as per the output of [`process.hrtime()`](https://nodejs.org/dist/latest/docs/api/process.html#process_process_hrtime_time).
154
+
155
+
#### Options
156
+
157
+
An optional object which may have the following keys:
158
+
159
+
| Name | Type | Default | Description |
160
+
| ---- | ---- | ------- | ----------- |
161
+
| chunker |`String`|`'size-262144`| chunking algorithm used to build ipfs DAGs |
162
+
| cidVersion |`Number`|`0`| the CID version to use when storing the data |
163
+
| hashAlg |`String`|`'sha2-256'`| multihash hashing algorithm to use |
164
+
| onlyHash |`boolean`|`false`| If true, will not add blocks to the blockstore |
165
+
| pin |`boolean`|`true`| pin this object when adding |
166
+
| progress | function |`undefined`| a function that will be called with the byte length of chunks as a file is added to ipfs |
167
+
| rawLeaves |`boolean`|`false`| if true, DAG leaves will contain raw file data and not be wrapped in a protobuf |
168
+
| trickle |`boolean`|`false`| if true will use the [trickle DAG](https://godoc.org/github.com/ipsn/go-ipfs/gxlibs/github.com/ipfs/go-unixfs/importer/trickle) format for DAG generation |
169
+
| wrapWithDirectory |`boolean`|`false`| Adds a wrapping node around the content |
170
+
| timeout |`Number`|`undefined`| A timeout in ms |
171
+
| signal |[AbortSignal][]|`undefined`| Can be used to cancel any long running requests started as a result of this call |
172
+
173
+
#### Returns
174
+
175
+
| Type | Description |
176
+
| -------- | -------- |
177
+
|`UnixFSEntry`| A object describing the added data |
0 commit comments