Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit c0e66cb

Browse files
committed
fix(CR): apply CR
1 parent 17f95fb commit c0e66cb

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ before_install:
1111

1212
script:
1313
- npm run lint
14-
- npm test
14+
- npm run test:node
1515
- npm run coverage
1616

1717
addons:

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,20 @@ Complete documentation for these methods is coming with: https://github.com/ipfs
116116

117117
#### Add files or entire directories from the FileSystem to IPFS
118118

119-
> `ipfs.util.fsAdd(path, option, callback)`
119+
> `ipfs.util.addFromFs(path, option, callback)`
120120
121-
Reads path from disk (if directory add an options `{ recursive: true }` and adds it to IPFS.
121+
Reads a file from `path` on the filesystem and adds it to IPFS. If `path` is a directory, use option `{ recursive: true }` to add the directory and all its sub-directories.
122122

123123
```JavaScript
124-
ipfs.util.fsAdd(<dirpath>, { recursive: true }, (err, result) => {
124+
ipfs.util.addFromFs('path/to/a/file', { recursive: true }, (err, result) => {
125125
if (err) {
126126
throw err
127127
}
128128
console.log(result)
129129
})
130130
```
131131

132-
`files` is an array of objects describing the files that were added, such as:
132+
`result` is an array of objects describing the files that were added, such as:
133133

134134
```
135135
[{
@@ -143,10 +143,10 @@ ipfs.util.fsAdd(<dirpath>, { recursive: true }, (err, result) => {
143143

144144
#### Add a file from a URL to IPFS
145145

146-
> `ipfs.util.urlAdd(url, callback)`
146+
> `ipfs.util.addFromURL(url, callback)`
147147
148148
```JavaScript
149-
ipfs.util.urlAdd('http://example.com/', (err, result) => {
149+
ipfs.util.addFromURL('http://example.com/', (err, result) => {
150150
if (err) {
151151
throw err
152152
}
@@ -157,12 +157,12 @@ ipfs.util.urlAdd('http://example.com/', (err, result) => {
157157

158158
#### Add a file from a stream to IPFS
159159

160-
> `ipfs.util.streamAdd(stream, callback)`
160+
> `ipfs.util.addFromStream(stream, callback)`
161161
162162
This is very similar to `ipfs.files.add({path:'', content: stream})`. It is like the reverse of cat
163163

164164
```JavaScript
165-
ipfs.util.streamAdd(<readable-stream>, (err, result) => {
165+
ipfs.util.addFromStream(<readable-stream>, (err, result) => {
166166
if (err) {
167167
throw err
168168
}

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
"main": "lib/index.js",
66
"jsnext:main": "src/index.js",
77
"scripts": {
8-
"test": "node --max_old_space_size=4096 node_modules/.bin/gulp test",
8+
"test": "node --max_old_space_size=4096 node_modules/.bin/gulp test:node",
99
"test:node": "gulp test:node",
1010
"test:browser": "node --max_old_space_size=4096 node_modules/.bin/gulp test:browser",
1111
"lint": "aegir-lint",
1212
"build": "gulp build",
13-
"release": "gulp release",
14-
"release-minor": "gulp release --type minor",
15-
"release-major": "gulp release --type major",
13+
"release": "node --max_old_space_size=4096 node_modules/.bin/gulp release",
14+
"release-minor": "node --max_old_space_size=4096 node_modules/.bin/gulp release --type minor",
15+
"release-major": "node --max_old_space_size=4096 node_modules/.bin/gulp release --type major",
1616
"coverage": "gulp coverage",
1717
"coverage-publish": "aegir-coverage publish"
1818
},

src/load-commands.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ function requireCommands () {
4747

4848
cmds.util = function (send) {
4949
const util = {
50-
fsAdd: require('./api/util/fs-add')(send),
51-
streamAdd: require('./api/add')(send),
52-
urlAdd: require('./api/util/url-add')(send)
50+
addFromFs: require('./api/util/fs-add')(send),
51+
addFromStream: require('./api/add')(send),
52+
addFromURL: require('./api/util/url-add')(send)
5353
}
5454
return util
5555
}

test/ipfs-api/util.spec.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ describe('.util', () => {
3535
const rs = fs.createReadStream(tfpath)
3636
rs.path = '' // clean the path for testing purposes
3737

38-
ipfs.util.streamAdd(rs, (err, result) => {
38+
ipfs.util.addFromStream(rs, (err, result) => {
3939
expect(err).to.not.exist
4040
expect(result.length).to.equal(1)
4141
done()
@@ -44,7 +44,7 @@ describe('.util', () => {
4444

4545
it('.fsAdd a directory', (done) => {
4646
const filesPath = path.join(__dirname, '../data/test-folder')
47-
ipfs.util.fsAdd(filesPath, { recursive: true }, (err, result) => {
47+
ipfs.util.addFromFs(filesPath, { recursive: true }, (err, result) => {
4848
expect(err).to.not.exist
4949
expect(result.length).to.be.above(8)
5050
done()
@@ -53,7 +53,7 @@ describe('.util', () => {
5353

5454
it('.fsAdd a file', (done) => {
5555
const filePath = path.join(__dirname, '../data/testfile.txt')
56-
ipfs.util.fsAdd(filePath, (err, result) => {
56+
ipfs.util.addFromFs(filePath, (err, result) => {
5757
expect(err).to.not.exist
5858
expect(result.length).to.be.above(5)
5959

@@ -62,7 +62,7 @@ describe('.util', () => {
6262
})
6363

6464
it('.urlAdd', (done) => {
65-
ipfs.util.urlAdd('http://example.com/', (err, result) => {
65+
ipfs.util.addFromURL('http://example.com/', (err, result) => {
6666
expect(err).to.not.exist
6767
expect(result.length).to.equal(1)
6868
done()

0 commit comments

Comments
 (0)