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

Commit 95c9020

Browse files
committed
Fix README re promises.
1 parent d90e8bb commit 95c9020

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ A valid (read: that follows this interface) IPFS core implementation, must expos
6767

6868
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
6969

70-
If no `callback` is passed, a promise is returned.
70+
Returns a [promise][].
7171

7272

7373

@@ -93,7 +93,7 @@ If no `callback` is passed, a promise is returned.
9393

9494
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
9595

96-
If no `callback` is passed, a promise is returned.
96+
Returns a [promise][].
9797

9898

9999

@@ -118,7 +118,7 @@ If no `callback` is passed, a promise is returned.
118118

119119
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
120120

121-
If no `callback` is passed, a promise is returned.
121+
Returns a [promise][].
122122

123123
### `object.data`
124124

@@ -138,7 +138,7 @@ If no `callback` is passed, a promise is returned.
138138

139139
`callback` must follow `function (err, data) {}` signature, where `err` is an error if the operation was not successful and `data` is a Buffer with the data that the MerkleDAG node contained.
140140

141-
If no `callback` is passed, a promise is returned.
141+
Returns a [promise][].
142142

143143
### `object.links`
144144

@@ -159,7 +159,7 @@ If no `callback` is passed, a promise is returned.
159159

160160
`callback` must follow `function (err, links) {}` signature, where `err` is an error if the operation was not successful and `links` is an Array of [DAGLink](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js#L199-L203) objects.
161161

162-
If no `callback` is passed, a promise is returned.
162+
Returns a [promise][].
163163

164164

165165

@@ -195,7 +195,7 @@ If no `callback` is passed, a promise is returned.
195195
}
196196
```
197197

198-
If no `callback` is passed, a promise is returned.
198+
Returns a [promise][].
199199

200200

201201

@@ -226,7 +226,7 @@ If no `callback` is passed, a promise is returned.
226226

227227
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
228228

229-
If no `callback` is passed, a promise is returned.
229+
Returns a [promise][].
230230

231231

232232

@@ -253,7 +253,7 @@ If no `callback` is passed, a promise is returned.
253253

254254
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
255255

256-
If no `callback` is passed, a promise is returned.
256+
Returns a [promise][].
257257

258258

259259

@@ -280,7 +280,7 @@ If no `callback` is passed, a promise is returned.
280280

281281
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
282282

283-
If no `callback` is passed, a promise is returned.
283+
Returns a [promise][].
284284

285285

286286

@@ -307,8 +307,9 @@ If no `callback` is passed, a promise is returned.
307307

308308
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
309309

310-
If no `callback` is passed, a promise is returned.
310+
Returns a [promise][].
311311

312312

313313
[DAGNode]: https://github.com/vijayee/js-ipfs-merkle-dag
314314
[multihash]: http://github.com/jbenet/multihash
315+
[promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

0 commit comments

Comments
 (0)