generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* hit dwn host health-check before selecting it * increase timeout for `Record.send` test * update `README` * bump versions * [web5] update README Co-authored-by: Daniel Buchner <[email protected]> Co-authored-by: Frank Hinek <[email protected]>
- Loading branch information
1 parent
e6ec1d0
commit 12435a1
Showing
11 changed files
with
275 additions
and
290 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
Making developing with Web5 components at least 5 times easier to work with. | ||
|
||
⚠️ WEB5 JS SDK IS CURRENTLY IN TECH PREVIEW ⚠️ | ||
> ⚠️ WEB5 JS SDK IS CURRENTLY IN TECH PREVIEW ⚠️ | ||
The SDK is currently still under active development, but having entered the Tech Preview phase there is now a drive to avoid unnecessary changes unless backwards compatibility is provided. Additional functionality will be added in the lead up to 1.0 final, and modifications will be made to address issues and community feedback. | ||
|
||
|
@@ -31,11 +31,11 @@ npm install @tbd54566975/web5 | |
_CDNs_ | ||
|
||
```yaml | ||
https://unpkg.com/@tbd54566975/[email protected].2/dist/browser.js | ||
https://unpkg.com/@tbd54566975/[email protected].3/dist/browser.js | ||
``` | ||
|
||
```yaml | ||
https://cdn.jsdelivr.net/npm/@tbd54566975/[email protected].2/dist/browser.mjs | ||
https://cdn.jsdelivr.net/npm/@tbd54566975/[email protected].3/dist/browser.mjs | ||
``` | ||
|
||
### Importing the SDK | ||
|
@@ -83,7 +83,7 @@ Each `Record` instance has the following instance methods: | |
- **`text`** - _`function`_: produces a textual representation of the data. | ||
- **`json`** - _`function`_: if the value is JSON data, this method will return a parsed JSON object. | ||
- **`stream`** - _`function`_: returns the raw stream of bytes for the data. | ||
- **`send`** - _`function`_: generates a `delete` entry tombstone for the record. This is a convenience method that allows you to easily delete records with less verbosity. | ||
- **`send`** - _`function`_: sends the record the instance represents to the DWeb Node endpoints of a provided DID. | ||
- **`update`** - _`function`_: takes in a new request object matching the expected method signature of a `write` and overwrites the record. This is a convenience method that allows you to easily overwrite records with less verbosity. | ||
- **`delete`** - _`function`_: generates a `delete` entry tombstone for the record. This is a convenience method that allows you to easily delete records with less verbosity. | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.