refactor: rename stringDigest to digest

Author: pi0

README.md

@@ -43,10 +43,10 @@ deno install ohash
 
 ```js
 // ESM import
-import { hash, serialize, isEqual, diff, stringDigest } from "ohash";
+import { hash, serialize, isEqual, diff, digest } from "ohash";
 
 // ..or dnamic import
-const { hash, serialize, stringDigest } = await import("ohash");
+const { hash, serialize, digest } = await import("ohash");
 ```
 
 ### `hash(object, options?)`
@@ -130,7 +130,7 @@ const diff = diff(obj1, obj2);
 console.log(diff(obj1, obj2));
 ```
 
-### `stringDigest`
+### `digest`
 
 Create a [sha256](https://en.wikipedia.org/wiki/SHA-2) digest from input and returns the hash as a base64 string.
 
@@ -139,10 +139,10 @@ Create a [sha256](https://en.wikipedia.org/wiki/SHA-2) digest from input and ret
 > This behavior differs from standard SHA-256 + Base64 encoding.
 
 ```ts
-import { stringDigest } from "ohash";
+import { digest } from "ohash";
 
 // "pZGm1Av0IEBKARczz7exkNYsZb8LzaMrV7J32a2fFG4"
-console.log(stringDigest("Hello World"));
+console.log(digest("Hello World"));
 ```
 
 ## 💻 Development

src/crypto/js/index.ts

@@ -7,6 +7,6 @@ import { SHA256 } from "./sha256";
  * **Note:** The `+`, `/`, and `=` characters are removed from the base64 result to maximize compatibility.
  * This behavior differs from standard SHA-256 + Base64 encoding.
  */
-export function stringDigest(message: string) {
+export function digest(message: string) {
   return new SHA256().finalize(message).toString(Base64);
 }

src/crypto/node/index.ts

@@ -6,7 +6,7 @@ import { createHash } from "node:crypto";
  * **Note:** The `+`, `/`, and `=` characters are removed from the base64 result to maximize compatibility.
  * This behavior differs from standard SHA-256 + Base64 encoding.
  */
-export function stringDigest(date: string): string {
+export function digest(date: string): string {
   return createHash("sha256")
     .update(date)
     .digest("base64")

src/hash.ts

@@ -1,5 +1,5 @@
 import { serialize, type SerializeOptions } from "./serialize";
-import { stringDigest } from "ohash/crypto";
+import { digest } from "ohash/crypto";
 
 /**
  * Hashes any JS value into a string.
@@ -16,5 +16,5 @@ import { stringDigest } from "ohash/crypto";
 export function hash(object: any, options: SerializeOptions = {}): string {
   const hashed =
     typeof object === "string" ? object : serialize(object, options);
-  return stringDigest(hashed).slice(0, 10);
+  return digest(hashed).slice(0, 10);
 }

src/index.ts

@@ -3,7 +3,7 @@ export { serialize, type SerializeOptions } from "./serialize";
 export { hash } from "./hash";
 
 // Crypto
-export { stringDigest } from "ohash/crypto";
+export { digest } from "ohash/crypto";
 
 // Utils
 export { isEqual } from "./utils/is-equal";

test/crypto.test.ts

@@ -11,16 +11,14 @@ const impls = {
   // distJs: cryptoDistJS,
 };
 
-describe("crypto:stringDigest", () => {
-  for (const [name, { stringDigest }] of Object.entries(impls)) {
+describe("crypto:digest", () => {
+  for (const [name, { digest }] of Object.entries(impls)) {
     describe(name, () => {
-      it("stringDigest", () => {
-        expect(stringDigest("Hello World")).toBe(
+      it("digest", () => {
+        expect(digest("Hello World")).toBe(
           "pZGm1Av0IEBKARczz7exkNYsZb8LzaMrV7J32a2fFG4",
         );
-        expect(stringDigest("")).toBe(
-          "47DEQpj8HBSaTImW5JCeuQeRkm5NMpJWZG3hSuFU",
-        );
+        expect(digest("")).toBe("47DEQpj8HBSaTImW5JCeuQeRkm5NMpJWZG3hSuFU");
       });
     });
   }