rename to safeDestr

README.md

@@ -28,16 +28,16 @@ Import into your Node.js project:
 
 ```js
 // CommonJS
-const { destr, destrSafe } = require("destr");
+const { destr, safeDestr } = require("destr");
 
 // ESM
-import { destr, destrSafe } from "destr";
+import { destr, safeDestr } from "destr";
 ```
 
 ### Deno
 
 ```js
-import { destr, destrSafe } from "https://deno.land/x/destr/src/index.ts";
+import { destr, safeDestr } from "https://deno.land/x/destr/src/index.ts";
 
 console.log(destr('{ "deno": "yay" }'));
 ```
@@ -98,14 +98,14 @@ destr(input);
 
 ### Strict Mode
 
-When using `destrSafe` it will throw an error if the input is not a valid JSON string or parsing fails. (non string values and built-ins will be still returned as-is)
+When using `safeDestr` it will throw an error if the input is not a valid JSON string or parsing fails. (non string values and built-ins will be still returned as-is)
 
 ```js
 // Returns "[foo"
-destrSafe("[foo");
+safeDestr("[foo");
 
 // Throws an error
-destrSafe("[foo", { strict: true });
+safeDestr("[foo", { strict: true });
 ```
 
 ## Benchmarks

lib/index.cjs

@@ -1,7 +1,7 @@
-const { destr, destrSafe } = require("../dist/index.cjs");
+const { destr, safeDestr } = require("../dist/index.cjs");
 
 // Allow mixed default and named exports
 destr.destr = destr;
-destr.destrSafe = destrSafe;
+destr.safeDestr = safeDestr;
 
 module.exports = destr;

src/index.ts

@@ -81,7 +81,7 @@ export function destr<T = unknown>(value: any, options: Options = {}): T {
   }
 }
 
-export function destrSafe<T = unknown>(value: any, options: Options = {}): T {
+export function safeDestr<T = unknown>(value: any, options: Options = {}): T {
   return destr<T>(value, { ...options, strict: true });
 }
 

test/index.test.ts

@@ -1,5 +1,5 @@
 import { expect, it, describe, vi } from "vitest";
-import { destr, destrSafe } from "../src";
+import { destr, safeDestr } from "../src";
 
 describe("destr", () => {
   it("returns the passed value if it's not a string", () => {
@@ -121,7 +121,7 @@ describe("destr", () => {
     }
   });
 
-  it("throws an error if it's a invalid JSON texts with destrSafe", () => {
+  it("throws an error if it's a invalid JSON texts with safeDestr", () => {
     const testCases = [
       { input: "{     ", output: "Unexpected end of JSON input" },
       { input: "[     ", output: "Unexpected end of JSON input" },
@@ -131,7 +131,7 @@ describe("destr", () => {
     ];
 
     for (const testCase of testCases) {
-      expect(() => destrSafe(testCase.input)).toThrowError(
+      expect(() => safeDestr(testCase.input)).toThrowError(
         testCase.output || ""
       );
     }