Update docs

This commit is contained in:
Manav Rathi
2024-09-07 10:07:55 +05:30
parent dd53cf4e58
commit b70444acac
3 changed files with 4 additions and 3 deletions

View File

@@ -193,7 +193,8 @@ export const encryptMetadataJSON = async (r: {
: sharedCryptoWorker().then((w) => w.encryptMetadataJSON(r));
/**
* Decrypt a box encrypted using {@link encryptBoxB64}.
* Decrypt a box encrypted using {@link encryptBoxB64} and returns the decrypted
* bytes.
*/
export const decryptBox = (box: EncryptedBox, key: BytesOrB64) =>
inWorker()

View File

@@ -390,7 +390,7 @@ export async function encryptFileChunk(
}
/**
* Decrypt the result of {@link encryptBoxB64}.
* Decrypt the result of {@link encryptBoxB64} and return the decrypted bytes.
*/
export const decryptBox = async (
{ encryptedData, nonce }: EncryptedBox,

View File

@@ -3,7 +3,7 @@ import { decryptBox } from "./crypto";
import { toB64 } from "./crypto/libsodium";
/**
* Return the user's master key (as a base64 string) from session storage.
* Return the user's master key from session storage.
*
* Precondition: The user should be logged in.
*/