Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-06-11 00:26:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Type defs for returned objects.

Browse Source
This commit is contained in:
Hayden Young 2023-06-27 21:51:26 +01:00
parent d6c2330122
commit eeb7e8d363
2 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/address.js
View File

@ -9,7 +9,7 @@ import { posixJoin } from './utils/path-join.js'
/**
* Validates an OrbitDB database address.
* @function
* @param {OrbitDBAddress|string} address An OrbitDB database address.
* @param {module:Address~OrbitDBAddress|string} address An OrbitDB database address.
* @return {boolean} True if the address is a valid OrbitDB database address,
* false otherwise.
* @static
@ -39,8 +39,8 @@ const isValidAddress = (address) => {
/**
* Parses an OrbitDB database address.
* @function
* @param {OrbitDBAddress|string} address A valid OrbitDB database address.
* @return {OrbitDBAddress} An instance of OrbitDBAddress.
* @param {module:Address~OrbitDBAddress|string} address A valid OrbitDB database address.
* @return {module:Address~OrbitDBAddress} An instance of OrbitDBAddress.
* @throws Not a valid OrbitDB address if no address if provided.
* @throws Not a valid OrbitDB address if address is invalid.
* @static
@ -57,6 +57,12 @@ const parseAddress = (address) => {
return OrbitDBAddress(address)
}
/**
* @typedef {Object} OrbitDBAddress
* @property {string} protocol The address protocol (/orbitdb/).
* @property {string} hash The hash of the database.
* @property {string} address The full database address.
*/
const OrbitDBAddress = (address) => {
if (address && address.protocol === 'orbitdb' && address.hash) {
return address
@ -66,6 +72,11 @@ const OrbitDBAddress = (address) => {
const hash = address.replace('/orbitdb/', '').replace('\\orbitdb\\', '')
/**
* Returns address as a string.
* @typedef {Function} toString
* @returns {string} Address as a string.
*/
const toString = () => {
return posixJoin('/', protocol, hash)
}

19
src/identities/identity.js
View File

@ -7,19 +7,20 @@ const codec = dagCbor
const hasher = sha256
const hashStringEncoding = base58btc
/**
* @typedef {Object} module:Identities~Identity
* @property {string} id A unique identifer for the identity.
* @property {object} publicKey A public key.
* @property {object} signatures A signed identity id and public key.
* @property {string} type The type of identity provider.
* @property {function} sign A sign function.
* @property {function} verify A verify function.
*/
const Identity = async ({ id, publicKey, signatures, type, sign, verify } = {}) => {
/**
* @namespace module:Identities~Identity
* @description The Identity instance. Returned by
* [Identities.createIdentity()]{@link module:Identities~Identities#createIdentity}.
*
* Available Identity instance properties and functions are:
* - **id:** A unique identifer for the identity.
* - **publicKey:** A public key.
* - **signatures:** A signed identity id and public key.
* - **type:** The type of identity provider.
* - **sign:** A sign function.
* - **verify:** A verify function.
*/
if (!id) throw new Error('Identity id is required')
if (!publicKey) throw new Error('Invalid public key')
@ -64,6 +65,7 @@ const decodeIdentity = async (bytes) => {
* @param {Identity} identity The identity to verify.
* @return {boolean} True if the identity is valid, false otherwise.
* @static
* @private
*/
const isIdentity = (identity) => {
return Boolean(identity.id &&
@ -82,6 +84,7 @@ const isIdentity = (identity) => {
* @param {Identity} b Second identity.
* @return {boolean} True if identity a and b are equal, false otherwise.
* @static
* @private
*/
const isEqual = (a, b) => {
return a.id === b.id &&