arweave-id
Advanced tools
Comparing version 2.0.0 to 2.0.2
{ | ||
"name": "arweave-id", | ||
"version": "2.0.0", | ||
"version": "2.0.2", | ||
"description": "", | ||
@@ -10,3 +10,3 @@ "main": "build/src/index.js", | ||
], | ||
"license": "Apache-2.0", | ||
"license": "LGPLv3", | ||
"keywords": [], | ||
@@ -13,0 +13,0 @@ "scripts": { |
@@ -10,5 +10,3 @@ # arweave-id Version 2 | ||
## Usage | ||
### Basic Usage | ||
## Basic Usage | ||
```javascript | ||
@@ -25,3 +23,3 @@ import Arweave from 'arweave/web' | ||
``` | ||
## API | ||
### ArweaveId interface | ||
@@ -37,3 +35,4 @@ ```javascript | ||
### `get(address: string, arweaveInstance: Arweave): Promise<ArweaveId>` | ||
### get | ||
`get(address: string, arweaveInstance: Arweave): Promise<ArweaveId>` | ||
Looks up the ArweaveID associated with a given Arweave address and returns all available data elements | ||
@@ -48,3 +47,4 @@ | ||
### `set(arweaveIdData: ArweaveId, jwk: JWKInterface, arweaveInstance: Arweave ): Promise<ISetReturn>` | ||
### set | ||
`set(arweaveIdData: ArweaveId, jwk: JWKInterface, arweaveInstance: Arweave ): Promise<ISetReturn>` | ||
Creates, signs, and submits an arweave-id transaction claiming ownership of the ArweaveId provided. | ||
@@ -63,3 +63,4 @@ | ||
### `check(name: string, arweaveInstance: IArweave): Promise<string>` | ||
### check | ||
`check(name: string, arweaveInstance: IArweave): Promise<string>` | ||
Look up an arweave-id name to see if it's available, returns an empty string `''` or the owners address. | ||
@@ -74,3 +75,4 @@ | ||
### `getIdenticon(name: string): string` | ||
### getIdenticon | ||
`getIdenticon(name: string): string` | ||
This function is provided as a method of generating an avatar for the user. Example usage, when the optional avatar has not been set. | ||
@@ -77,0 +79,0 @@ |
Mixed license
License(Experimental) Package contains multiple licenses.
Found 1 instance in 1 package
35042
2
79