Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-10-07 22:57:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix links and add clarification in Identities api docs

Browse Source
This commit is contained in:
haad
2023-06-30 08:48:35 +03:00
parent 3ac96ee18d
commit ce8235ff04
2 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/identities/identities.js
View File

@@ -52,7 +52,7 @@ const Identities = async ({ keystore, path, storage, ipfs } = {}) => {
/**
* Gets an identity by hash.
* @param {string} hash An identity hash.
* @return {Identity} An instance of identity.
* @return {module:Identities~Identity} An instance of identity.
* @memberof module:Identities~Identities
* @instance
*/

5
src/identities/identity.js
View File

@@ -13,12 +13,11 @@ const hashStringEncoding = base58btc
* @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.
* @property {function} sign A sign function to sign data using this identity.
* @property {function} verify A verify function to verify data signed by this identity.
*/
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}.
*/