Skip to content

Commit

Permalink
feat: support adding files via async iterator (ipfs#1078)
Browse files Browse the repository at this point in the history
Adds a method called `ipfs._addAsyncIterator`, prefixed with an
underscore to mark it as sort of unofficial (though it's what
`ipfs.add` will become once the async iterator migration is complete)
and we don't want to implement symmetrical `ipfs.catAsyncIterator`
etc methods, or at least not yet.
  • Loading branch information
achingbrain authored and Alan Shaw committed Aug 29, 2019
1 parent 69a56cb commit 377042b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/files-regular/add-async-iterator.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
'use strict'

const SendFilesStream = require('../utils/send-files-stream')
const FileResultStreamConverter = require('../utils/file-result-stream-converter')

module.exports = (send) => {
return async function * (source, options) {
options = options || {}
options.converter = FileResultStreamConverter

const stream = SendFilesStream(send, 'add')(options)

for await (const entry of source) {
stream.write(entry)
}

stream.end()

for await (const entry of stream) {
yield entry
}
}
}
1 change: 1 addition & 0 deletions src/files-regular/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module.exports = (arg) => {
addFromFs: require('../files-regular/add-from-fs')(send),
addFromURL: require('../files-regular/add-from-url')(send),
addFromStream: require('../files-regular/add')(send),
_addAsyncIterator: require('../files-regular/add-async-iterator')(send),
cat: require('../files-regular/cat')(send),
catReadableStream: require('../files-regular/cat-readable-stream')(send),
catPullStream: require('../files-regular/cat-pull-stream')(send),
Expand Down
1 change: 1 addition & 0 deletions src/utils/load-commands.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ function requireCommands () {
addFromFs: require('../files-regular/add-from-fs'),
addFromURL: require('../files-regular/add-from-url'),
addFromStream: require('../files-regular/add'),
_addAsyncIterator: require('../files-regular/add-async-iterator'),
cat: require('../files-regular/cat'),
catReadableStream: require('../files-regular/cat-readable-stream'),
catPullStream: require('../files-regular/cat-pull-stream'),
Expand Down

0 comments on commit 377042b

Please sign in to comment.