OrbitDB database address verification.
- Source:
Methods
(static) isValidAddress(address) → {boolean}
Validates an OrbitDB database address.
Parameters:
| Name | Type | Description |
|---|---|---|
address |
module:Address~OrbitDBAddress | string | An OrbitDB database address. |
- Source:
Returns:
True if the address is a valid OrbitDB database address, false otherwise.
- Type
- boolean
(static) parseAddress(address) → {module:Address~OrbitDBAddress}
Parses an OrbitDB database address.
Parameters:
| Name | Type | Description |
|---|---|---|
address |
module:Address~OrbitDBAddress | string | A valid OrbitDB database address. |
- Source:
Throws:
-
Not a valid OrbitDB address if no address if provided.
-
Not a valid OrbitDB address if address is invalid.
Returns:
An instance of OrbitDBAddress.
Type Definitions
OrbitDBAddress
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
protocol |
string | Protocol prefix "/orbitdb/". |
hash |
string | The hash of the database manifest. |
address |
string | The full database address. |
- Source:
toString() → {string}
Returns address as a string.
- Source:
Returns:
Address as a string.
- Type
- string