docs(crypto): complete documentation

crypto/crypto.ts

@@ -128,6 +128,8 @@ import {
 } from "./_wasm/mod.ts";
 import { fnv } from "./_fnv/mod.ts";
 
+export { type WasmDigestAlgorithm, wasmDigestAlgorithms };
+
 /**
  * A copy of the global WebCrypto interface, with methods bound so they're
  * safe to re-export.
@@ -186,6 +188,7 @@ export interface StdSubtleCrypto extends SubtleCrypto {
 
 /** Extensions to the Web {@linkcode Crypto} interface. */
 export interface StdCrypto extends Crypto {
+  /** Extension to the {@linkcode crypto.SubtleCrypto} interface. */
   readonly subtle: StdSubtleCrypto;
 }
 
@@ -213,7 +216,7 @@ const stdCrypto: StdCrypto = ((x) => x)({
 
       const bytes = bufferSourceBytes(data);
 
-      if (FNVAlgorithms.includes(name)) {
+      if (FNV_ALGORITHMS.includes(name)) {
         return fnv(name, bytes);
       }
 
@@ -277,7 +280,7 @@ const stdCrypto: StdCrypto = ((x) => x)({
 
       const bytes = bufferSourceBytes(data);
 
-      if (FNVAlgorithms.includes(name)) {
+      if (FNV_ALGORITHMS.includes(name)) {
         return fnv(name, bytes);
       }
 
@@ -304,7 +307,7 @@ const stdCrypto: StdCrypto = ((x) => x)({
   },
 });
 
-const FNVAlgorithms = ["FNV32", "FNV32A", "FNV64", "FNV64A"];
+const FNV_ALGORITHMS = ["FNV32", "FNV32A", "FNV64", "FNV64A"];
 
 /** Digest algorithms supported by WebCrypto. */
 const webCryptoDigestAlgorithms = [
@@ -315,7 +318,10 @@ const webCryptoDigestAlgorithms = [
   "SHA-1",
 ] as const;
 
+/** FNV (Fowler/Noll/Vo) algorithms names. */
 export type FNVAlgorithms = "FNV32" | "FNV32A" | "FNV64" | "FNV64A";
+
+/** Extended digest algorithm names. */
 export type DigestAlgorithmName = WasmDigestAlgorithm | FNVAlgorithms;
 
 /*
@@ -341,11 +347,15 @@ function assertValidDigestLength(value?: number) {
   }
 }
 
+/** Extended digest algorithm objects. */
 export type DigestAlgorithmObject = {
   name: DigestAlgorithmName;
   length?: number;
 };
 
+/**
+ * Extended digest algorithms accepted by {@linkcode stdCrypto.subtle.digest}.
+ */
 export type DigestAlgorithm = DigestAlgorithmName | DigestAlgorithmObject;
 
 function normalizeAlgorithm(algorithm: DigestAlgorithm) {

crypto/to_hash_string.ts

@@ -5,8 +5,6 @@ import { encodeHex } from "../encoding/hex.ts";
 import { encodeBase64 } from "../encoding/base64.ts";
 
 /**
- * @deprecated (will be removed after 0.209.0) Use {@linkcode encodeHex} or {@linkcode encodeBase64} instead.
- *
  * Converts a hash to a string with a given encoding.
  * @example
  * ```ts
@@ -21,6 +19,8 @@ import { encodeBase64 } from "../encoding/base64.ts";
  * // Or with base64 encoding
  * console.log(toHashString(hash, "base64"));
  * ```
+ *
+ * @deprecated (will be removed after 0.209.0) Use {@linkcode encodeHex} or {@linkcode encodeBase64} instead.
  */
 export function toHashString(
   hash: ArrayBuffer,

crypto/unstable_keystack.ts

@@ -96,6 +96,7 @@ export class KeyStack {
     return this.#cryptoKeys.get(key)!;
   }
 
+  /** Number of keys */
   get length(): number {
     return this.#keys.length;
   }
@@ -145,7 +146,9 @@ export class KeyStack {
     return -1;
   }
 
-  [Symbol.for("Deno.customInspect")](inspect: (value: unknown) => string) {
+  [Symbol.for("Deno.customInspect")](
+    inspect: (value: unknown) => string,
+  ): string {
     const { length } = this;
     return `${this.constructor.name} ${inspect({ length })}`;
   }
@@ -155,7 +158,7 @@ export class KeyStack {
     // deno-lint-ignore no-explicit-any
     options: any,
     inspect: (value: unknown, options?: unknown) => string,
-  ) {
+  ): string {
     if (depth < 0) {
       return options.stylize(`[${this.constructor.name}]`, "special");
     }