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

Fix doc reference

Browse Source
This commit is contained in:
Arnaud 2025-04-02 17:08:06 +02:00
parent 555619a02b
commit 0e93a6040b
No known key found for this signature in database
GPG Key ID: 69D6CE281FCAE663
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -282,7 +282,7 @@ const data = codex.data;
Returns the manifest stored locally in node. Returns the manifest stored locally in node.
- returns Promise<[CodexDataItem](./src/data/types.ts#L7)[]> - returns Promise<[CodexDataItem](./src/data/types.ts#L8)[]>
Example: Example:
@ -294,7 +294,7 @@ const cids = await data.cids();
Returns a summary of the storage space allocation of the node Returns a summary of the storage space allocation of the node
- returns Promise<[CodexNodeSpace](./src/data/types.ts#L14)[]> - returns Promise<[CodexNodeSpace](./src/data/types.ts#L15)[]>
Example: Example:
@ -309,7 +309,7 @@ Upload a file in a streaming manner
#### Browser #### Browser
- stategy [BrowserUploadStategy](./src/data/browser-upload.ts#L5) - stategy [BrowserUploadStategy](./src/data/browser-upload.ts#L5)
- returns [UploadResponse](./src/data/types.ts#L16) - returns [UploadResponse](./src/data/types.ts#L17)
Example: Example:
@ -338,8 +338,8 @@ console.info("CID is", res.data);
#### Node #### Node
- stategy [NodeUploadStategy](./src/data/node-upload.ts#L8) - stategy [NodeUploadStategy](./src/data/node-upload.ts#L9)
- returns [UploadResponse](./src/data/types.ts#L16) - returns [UploadResponse](./src/data/types.ts#L17)
Example: Example:
@ -362,7 +362,7 @@ console.info("CID is", res.data);
Download only the dataset manifest from the network to the local node if it's not available locally. Download only the dataset manifest from the network to the local node if it's not available locally.
- cid (string, required) - cid (string, required)
- returns [CodexManifest](./src/data/types.ts#L29) - returns [CodexManifest](./src/data/types.ts#L30)
Example: Example: