mirror of
https://github.com/logos-storage/logos-storage-js.git
synced 2026-01-02 13:33:07 +00:00
various small README and comment fixes
This commit is contained in:
parent
6a890262cc
commit
4906681a8e
@ -55,7 +55,7 @@ const codex = new Codex("http://localhost:3000");
|
||||
To use a module, you need to use the await syntax. If the module is not loaded yet, it will be imported first and then cached in memory.
|
||||
|
||||
```js
|
||||
const marketplace = await codex.marketplace;
|
||||
const marketplace = await codex.marketplace();
|
||||
```
|
||||
|
||||
### Error handling
|
||||
@ -241,7 +241,7 @@ The following API assume that you have already a data module loaded, example:
|
||||
|
||||
```js
|
||||
const codex = new Codex("http://localhost:3000");
|
||||
const data = await codex.data;
|
||||
const data = await codex.data();
|
||||
```
|
||||
|
||||
#### cids
|
||||
@ -342,7 +342,7 @@ The following API assume that you have already a node module loaded, example:
|
||||
|
||||
```js
|
||||
const codex = new Codex("http://localhost:3000");
|
||||
const data = await codex.debug;
|
||||
const data = await codex.debug();
|
||||
```
|
||||
|
||||
#### setLogLevel
|
||||
@ -376,7 +376,7 @@ The following API assume that you have already a node module loaded, example:
|
||||
|
||||
```js
|
||||
const codex = new Codex("http://localhost:3000");
|
||||
const node = await codex.node;
|
||||
const node = await codex.node();
|
||||
```
|
||||
|
||||
#### spr
|
||||
|
||||
@ -127,8 +127,8 @@ export class CodexData {
|
||||
}
|
||||
|
||||
/**
|
||||
* Download a file from the network in a streaming manner.
|
||||
* If the file is not available locally, it will be retrieved from other nodes in the network if able.
|
||||
* Download a file from the network to the local node if it's not available locally.
|
||||
* Note: Download is performed async. Call can return before download is completed.
|
||||
*/
|
||||
async networkDownload(cid: string): Promise<SafeValue<NetworkDownloadResponse>> {
|
||||
const url = this.url + Api.config.prefix + `/data/${cid}/network`;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user