logos-storage/logos-storage-js
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-js.git synced 2026-01-02 13:33:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: use correct node's api port (#15)

Browse Source
This commit is contained in:
Adam Uhlíř 2025-04-09 16:42:08 +02:00 committed by GitHub
parent 496aae84e7
commit 9cc497feca
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -37,7 +37,7 @@ const { Codex } = require("@codex-storage/sdk-js");
To create a Codex instance, provide the REST API url to interact with the Codex client:
```js
const codex = new Codex("http://localhost:3000");
const codex = new Codex("http://localhost:8080");
```
Then you can access any module like this:
@ -61,7 +61,7 @@ const { Codex } = require("@codex-storage/sdk-js/async");
To create a Codex instance, provide the REST API url to interact with the Codex client:
```js
const codex = new Codex("http://localhost:3000");
const codex = new Codex("http://localhost:8080");
```
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.
@ -75,7 +75,7 @@ const marketplace = await codex.marketplace();
You can use basic authentication when creating a new Codex object:
```js
const codex = new Codex("http://localhost:3000", {
const codex = new Codex("http://localhost:8080", {
auth: {
basic: "MY BASIC AUTH SECRET"
}
@ -122,7 +122,7 @@ if (slots.error) {
The following API assume that you have already a marketplace module loaded, example:
```js
const codex = new Codex("http://localhost:3000");
const codex = new Codex("http://localhost:8080");
// When using the async api
const marketplace = await codex.marketplace();
@ -270,7 +270,7 @@ const purchase = await marketplace.purchaseDetail(purchaseId);
The following API assume that you have already a data module loaded, example:
```js
const codex = new Codex("http://localhost:3000");
const codex = new Codex("http://localhost:8080");
// When using the async api
const data = await codex.data();
@ -406,7 +406,7 @@ const result = await data.localDownload(cid);
The following API assume that you have already a node module loaded, example:
```js
const codex = new Codex("http://localhost:3000");
const codex = new Codex("http://localhost:8080");
// When using the async api
const data = await codex.debug();
@ -444,7 +444,7 @@ const info = await debug.info();
The following API assume that you have already a node module loaded, example:
```js
const codex = new Codex("http://localhost:3000");
const codex = new Codex("http://localhost:8080");
// When using the async api
const node = await codex.node();