🤖 Merge PR DefinitelyTyped#74514 Add type definitions for memorystorage by @Zephyr-Blessed

Co-authored-by: Zephyr-Blessed <zephyr-blessed@users.noreply.github.com>
Co-authored-by: Zephyr-Blessed <zephyr@aitruist.org>

Author: Zephyr-Blessed

types/memorystorage/.npmignore

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

types/memorystorage/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * A memory-backed implementation of the Web Storage API.
+ *
+ * @see https://github.com/download/memorystorage
+ */
+
+interface MemoryStorage {
+    /** The identifier for this storage instance. */
+    readonly id: string;
+
+    /** The number of key/value pairs currently present in the storage. */
+    readonly length: number;
+
+    /**
+     * Returns the value associated with the given key, or `null` if the key does not exist.
+     * @param key The name of the key to retrieve the value of.
+     */
+    getItem(key: string): string | null;
+
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * @param key The name of the key to create/update.
+     * @param value The value to set.
+     */
+    setItem(key: string, value: string): void;
+
+    /**
+     * Removes the key/value pair with the given key, if a key/value pair with the given key exists.
+     * @param key The name of the key to remove.
+     */
+    removeItem(key: string): void;
+
+    /**
+     * Returns the name of the nth key, or `null` if n is greater than or equal to the number of key/value pairs.
+     * @param index The index of the key to return.
+     */
+    key(index: number): string | null;
+
+    /**
+     * Removes all key/value pairs, if there are any.
+     */
+    clear(): void;
+
+    /** Index signature to allow accessing stored items as properties. */
+    [key: string]: any;
+}
+
+interface MemoryStorageConstructor {
+    /**
+     * Creates a new MemoryStorage object implementing the Web Storage API using memory.
+     *
+     * If no arguments are given, the created memory storage object will read from and write to the
+     * `global` memory storage. If a string argument is given, the new storage object will read from
+     * and write to its own segment of memory.
+     *
+     * Can be called with or without `new`.
+     *
+     * @param id Optional string argument used to isolate this memory storage object from others.
+     */
+    new(id?: string): MemoryStorage;
+    (id?: string): MemoryStorage;
+}
+
+declare const MemoryStorage: MemoryStorageConstructor;
+
+export = MemoryStorage;

types/memorystorage/memorystorage-tests.ts

@@ -0,0 +1,35 @@
+import MemoryStorage = require("memorystorage");
+
+// Can be called with new
+const storage1 = new MemoryStorage("test-1");
+
+// Can be called without new
+const storage2 = MemoryStorage("test-2");
+
+// Can be called with no arguments (uses global)
+const globalStorage = new MemoryStorage();
+
+// $ExpectType string
+storage1.id;
+
+// $ExpectType number
+storage1.length;
+
+// $ExpectType string | null
+storage1.getItem("key");
+
+// $ExpectType void
+storage1.setItem("key", "value");
+
+// $ExpectType void
+storage1.removeItem("key");
+
+// $ExpectType string | null
+storage1.key(0);
+
+// $ExpectType void
+storage1.clear();
+
+// Can set/get properties directly via index signature
+storage1["myKey"] = "myValue";
+const val: any = storage1["myKey"];

types/memorystorage/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/memorystorage",
+    "version": "0.12.9999",
+    "projects": [
+        "https://github.com/download/memorystorage"
+    ],
+    "devDependencies": {
+        "@types/memorystorage": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Zephyr-Blessed",
+            "githubUsername": "Zephyr-Blessed"
+        }
+    ]
+}

types/memorystorage/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",
+        "memorystorage-tests.ts"
+    ]
+}