From 90cffef7bedd3b9633f0b18cd0d0f3e3dea85784 Mon Sep 17 00:00:00 2001 From: Manav Rathi Date: Wed, 26 Jun 2024 19:15:09 +0530 Subject: [PATCH] Doc --- web/packages/shared/crypto/internal/libsodium.ts | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/web/packages/shared/crypto/internal/libsodium.ts b/web/packages/shared/crypto/internal/libsodium.ts index 704914b17d..847b81424e 100644 --- a/web/packages/shared/crypto/internal/libsodium.ts +++ b/web/packages/shared/crypto/internal/libsodium.ts @@ -15,12 +15,17 @@ export async function fromB64(input: string) { return sodium.from_base64(input, sodium.base64_variants.ORIGINAL); } -export async function toB64(input: Uint8Array) { +/** + * Convert a {@link Uint8Array} to a Base64 encoded string. + * + * See also {@link toB64URLSafe} and {@link toB64URLSafeNoPadding}. + */ +export const toB64 = async (input: Uint8Array) => { await sodium.ready; return sodium.to_base64(input, sodium.base64_variants.ORIGINAL); -} +}; -/** Convert a {@link Uint8Array} to a URL safe Base64 encoded string. */ +/** Convert a {@link Uint8Array} to a **URL safe** Base64 encoded string. */ export const toB64URLSafe = async (input: Uint8Array) => { await sodium.ready; return sodium.to_base64(input, sodium.base64_variants.URLSAFE);