Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-06-05 21:56:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify keystore api docs

Browse Source
This commit is contained in:
haad 2023-06-30 08:56:05 +03:00
parent ce8235ff04
commit 200b215112
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/key-store.js
View File

@ -146,8 +146,8 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
/** /**
* Checks if the key exists in the key store. * Checks if a key exists in the key store .
* @param {string} id The id of the private key in the key store. * @param {string} id The id of an [Identity]{@link module:Identities~Identity} to check the key for.
* @return {boolean} True if the key exists, false otherwise. * @return {boolean} True if the key exists, false otherwise.
* @throws id needed to check a key if no id is specified. * @throws id needed to check a key if no id is specified.
* @memberof module:KeyStore~KeyStore * @memberof module:KeyStore~KeyStore
@ -172,9 +172,9 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
/** /**
* Adds a key to the keystore. * Adds a private key to the keystore.
* @param {string} id A storage id for the key. * @param {string} id An id of the [Identity]{@link module:Identities~Identity} to whom the key belongs to.
* @param {Uint8Array} key The key to store. * @param {Uint8Array} key The private key to store.
* @memberof module:KeyStore~KeyStore * @memberof module:KeyStore~KeyStore
* @async * @async
* @instance * @instance
@ -184,8 +184,8 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
/** /**
* Creates a key, storing it to the keystore. * Creates a key pair and stores it to the keystore.
* @param {string} id A storage id for the key. * @param {string} id An id of the [Identity]{@link module:Identities~Identity} to generate the key pair for.
* @throws id needed to create a key if no id is specified. * @throws id needed to create a key if no id is specified.
* @memberof module:KeyStore~KeyStore * @memberof module:KeyStore~KeyStore
* @async * @async
@ -212,8 +212,8 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
/** /**
* Gets the key from keystore. * Gets a key from keystore.
* @param {string} id A storage id of the key. * @param {string} id An id of the [Identity]{@link module:Identities~Identity} whose key to retrieve.
* @return {Uint8Array} The key specified by id. * @return {Uint8Array} The key specified by id.
* @throws id needed to get a key if no id is specified. * @throws id needed to get a key if no id is specified.
* @memberof module:KeyStore~KeyStore * @memberof module:KeyStore~KeyStore
@ -240,7 +240,7 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
/** /**
* Gets th serialized public key from a key pair. * Gets the serialized public key from a key pair.
* @param {*} keys A key pair. * @param {*} keys A key pair.
* @param {Object} options One or more options. * @param {Object} options One or more options.
* @param {Object} [options.format=hex] The format the public key should be * @param {Object} [options.format=hex] The format the public key should be