Merge pull request #143 from ipfs/feat/support-path

feat: add support for paths on get and cat

Author: daviddias

API/files/README.md

@@ -111,19 +111,24 @@ A great source of [examples][] can be found in the tests for this API.
 
 ##### `Go` **WIP**
 
-##### `JavaScript` - ipfs.files.cat(multihash, [callback])
+##### `JavaScript` - ipfs.files.cat(ipfsPath, [callback])
 
-`multihash` is a [multihash][] which can be passed as
+ipfsPath can be of type:
 
-- Buffer, the raw Buffer of the multihash
-- String, the base58 encoded version of the multihash
+- `multihash` is a [multihash][] which can be passed as
+  - Buffer, the raw Buffer of the multihash
+  - String, the base58 encoded version of the multihash
+- String, including the ipfs handler, a multihash and a path to traverse to, ie:
+  - '/ipfs/QmXEmhrMpbVvTh61FNAxP9nU7ygVtyvZA8HZDUaqQCAb66'
+  - '/ipfs/QmXEmhrMpbVvTh61FNAxP9nU7ygVtyvZA8HZDUaqQCAb66/a.txt'
+  - 'QmXEmhrMpbVvTh61FNAxP9nU7ygVtyvZA8HZDUaqQCAb66/a.txt'
 
 `callback` must follow `function (err, stream) {}` signature, where `err` is an error if the operation was not successful and `stream` is a readable stream of the file.
 
 If no `callback` is passed, a promise is returned.
 
 ```JavaScript
-ipfs.files.cat(multihash, function (err, file) {
+ipfs.files.cat(ipfsPath, function (err, file) {
   // file will be a stream containing the data of the file requested
 })
 ```
@@ -136,9 +141,17 @@ A great source of [examples][] can be found in the tests for this API.
 
 ##### `Go` **WIP**
 
-##### `JavaScript` - ipfs.files.get(multihash, [callback])
+##### `JavaScript` - ipfs.files.get(ipfsPath, [callback])
 
-Where `multihash` is an IPFS multihash or string multihash.
+ipfsPath can be of type:
+
+- `multihash` is a [multihash][] which can be passed as
+  - Buffer, the raw Buffer of the multihash
+  - String, the base58 encoded version of the multihash
+- String, including the ipfs handler, a multihash and a path to traverse to, ie:
+  - '/ipfs/QmXEmhrMpbVvTh61FNAxP9nU7ygVtyvZA8HZDUaqQCAb66'
+  - '/ipfs/QmXEmhrMpbVvTh61FNAxP9nU7ygVtyvZA8HZDUaqQCAb66/a.txt'
+  - 'QmXEmhrMpbVvTh61FNAxP9nU7ygVtyvZA8HZDUaqQCAb66/a.txt'
 
 `callback` must follow `function (err, stream) {}` signature, where `err` is an
 error if the operation was not successful. `stream` will be a Readable stream in

package-lock.json

@@ -63,4 +63,4 @@
     "haad <[email protected]>",
     "nginnever <[email protected]>"
   ]
-}
+}