🤖 Merge PR DefinitelyTyped#74465 Add types for should-format by @gasp

Author: gasp

types/should-format/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/should-format/index.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Options for the Formatter.
+ */
+interface FormatterOptions {
+    /**
+     * Custom function to get keys from an object.
+     */
+    keysFunc?: (obj: object) => string[];
+
+    /**
+     * If false, uses Object.getOwnPropertyNames instead of Object.keys.
+     */
+    keys?: boolean;
+
+    /**
+     * Maximum line length before wrapping. Default: 60.
+     */
+    maxLineLength?: number;
+
+    /**
+     * Property separator. Default: ','.
+     */
+    propSep?: string;
+
+    /**
+     * If true, formats dates in UTC.
+     */
+    isUTCdate?: boolean;
+}
+
+/**
+ * Formatter class for converting values to string representations.
+ */
+declare class Formatter {
+    constructor(opts?: FormatterOptions);
+
+    /**
+     * Format a value to a string representation.
+     * @param value - The value to format
+     * @returns Formatted string representation
+     */
+    format(value: unknown): string;
+}
+
+/**
+ * Default format function that creates a Formatter and formats the value.
+ *
+ * @param value - The value to format
+ * @param opts - Optional formatter options
+ * @returns Formatted string representation
+ *
+ * @example
+ * ```javascript
+ * const format = require('should-format');
+ *
+ * format({ a: 1, b: 2 }); // => "{ a: 1, b: 2 }"
+ * format([1, 2, 3]); // => "[ 1, 2, 3 ]"
+ * format(null); // => "null"
+ * ```
+ */
+declare function format(value: unknown, opts?: FormatterOptions): string;
+
+declare namespace format {
+    export { Formatter, FormatterOptions };
+}
+
+export = format;

types/should-format/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/should-format",
+    "version": "3.0.9999",
+    "projects": [
+        "https://github.com/shouldjs/format"
+    ],
+    "devDependencies": {
+        "@types/should-format": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "gaspard",
+            "githubUsername": "gasp"
+        }
+    ]
+}

types/should-format/should-format-tests.ts

@@ -0,0 +1,40 @@
+import format = require("should-format");
+
+// Test default format function
+const objStr: string = format({ a: 1, b: 2 });
+const arrStr: string = format([1, 2, 3]);
+const nullStr: string = format(null);
+const undefinedStr: string = format(undefined);
+const numStr: string = format(42);
+const boolStr: string = format(true);
+const strStr: string = format("hello");
+const dateStr: string = format(new Date());
+const regexStr: string = format(/test/g);
+
+// Test with options
+const withOptions: string = format({ a: 1 }, {
+    maxLineLength: 80,
+    propSep: ";",
+    isUTCdate: true,
+});
+
+// Test with keysFunc option
+const withKeysFunc: string = format({ a: 1, b: 2 }, {
+    keysFunc: (obj) => Object.keys(obj).reverse(),
+});
+
+// Test with keys: false option
+const withAllKeys: string = format({ a: 1 }, {
+    keys: false,
+});
+
+// Test Formatter class
+const formatter = new format.Formatter();
+const formatted: string = formatter.format({ test: true });
+
+// Test Formatter with options
+const formatterWithOpts = new format.Formatter({
+    maxLineLength: 100,
+    propSep: ",",
+});
+const formatted2: string = formatterWithOpts.format([1, 2, 3]);

types/should-format/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "should-format-tests.ts"
+    ]
+}