@fsvreddit/fsv-devvit-web-helpers 0.2.1 → 0.2.2

package/LICENSE

@@ -1,28 +1,28 @@
-BSD 3-Clause License
-
-Copyright (c) 2024, fsv
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2024, fsv
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/redis/redisHelpers.d.ts

@@ -46,4 +46,10 @@ export declare function zRangeAsRecord(key: string, start: number | string, stop
  * @param expireAt The expiration date.
  */
 export declare function expireKeyAt(key: string, expireAt: Date): Promise<void>;
+/**
+ * Retrieves multiple keys from Redis and returns them as a record/object.
+ * @param keys The keys to retrieve.
+ * @returns {Record<string, string>} A record/object with keys and their corresponding values.
+ */
+export declare function mGetAsRecord(keys: string[]): Promise<Record<string, string>>;
 export {};

package/dist/redis/redisHelpers.js

@@ -6,6 +6,7 @@ exports.hMGetAsRecord = hMGetAsRecord;
 exports.hGetAllChunked = hGetAllChunked;
 exports.zRangeAsRecord = zRangeAsRecord;
 exports.expireKeyAt = expireKeyAt;
+exports.mGetAsRecord = mGetAsRecord;
 const server_1 = require("@devvit/web/server");
 const date_fns_1 = require("date-fns");
 const lodash_es_1 = require("lodash-es");
@@ -120,3 +121,19 @@ async function expireKeyAt(key, expireAt) {
         throw new Error(`Expire time ${expireAt.toISOString()} is in the past`);
     }
 }
+/**
+ * Retrieves multiple keys from Redis and returns them as a record/object.
+ * @param keys The keys to retrieve.
+ * @returns {Record<string, string>} A record/object with keys and their corresponding values.
+ */
+async function mGetAsRecord(keys) {
+    const results = await server_1.redis.mGet(keys);
+    const record = {};
+    keys.forEach((key, index) => {
+        const value = results[index];
+        if (value !== null) {
+            record[key] = value;
+        }
+    });
+    return record;
+}

package/eslint.config.mjs

@@ -1,3 +1,3 @@
-import fsvconfig from "@fsvreddit/eslint-config";
-
-export default fsvconfig;
+import fsvconfig from "@fsvreddit/eslint-config";
+
+export default fsvconfig;

package/package.json

@@ -1,46 +1,46 @@
-{
-    "name": "@fsvreddit/fsv-devvit-web-helpers",
-    "version": "0.2.1",
-    "description": "Helper functions and utilities for Devvit Web apps on Reddit",
-    "main": "dist/index.js",
-    "scripts": {
-        "lint": "eslint . --ext .ts",
-        "build": "tsc --project tsconfig.build.json",
-        "prepare": "npm run build"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/fsvreddit/fsv-devvit-web-helpers.git"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "author": "fsv",
-    "license": "BSD-3-Clause",
-    "dependencies": {
-        "date-fns": "^4.1.0",
-        "hono": "^4.12.30",
-        "json2md": "^2.0.3",
-        "lodash-es": "^4.18.1",
-        "marked": "^18.0.11",
-        "semver": "^7.8.5"
-    },
-    "devDependencies": {
-        "@fsvreddit/eslint-config": "^0.1.0",
-        "@types/json2md": "^1.5.4",
-        "@types/lodash-es": "^4.17.12",
-        "@types/semver": "^7.7.1",
-        "eslint": "^10.0.2",
-        "typescript": "^5.8.3"
-    },
-    "keywords": [
-        "reddit",
-        "devvit"
-    ],
-    "peerDependencies": {
-        "@devvit/protos": "^0.14.6",
-        "@devvit/reddit": "^0.14.6",
-        "@devvit/shared-types": "^0.14.6",
-        "@devvit/web": "^0.14.6"
-    }
-}
+{
+    "name": "@fsvreddit/fsv-devvit-web-helpers",
+    "version": "0.2.2",
+    "description": "Helper functions and utilities for Devvit Web apps on Reddit",
+    "main": "dist/index.js",
+    "scripts": {
+        "lint": "eslint . --ext .ts",
+        "build": "tsc --project tsconfig.build.json",
+        "prepare": "npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/fsvreddit/fsv-devvit-web-helpers.git"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "author": "fsv",
+    "license": "BSD-3-Clause",
+    "dependencies": {
+        "date-fns": "^4.1.0",
+        "hono": "^4.12.30",
+        "json2md": "^2.0.3",
+        "lodash-es": "^4.18.1",
+        "marked": "^18.0.11",
+        "semver": "^7.8.5"
+    },
+    "devDependencies": {
+        "@fsvreddit/eslint-config": "^0.1.0",
+        "@types/json2md": "^1.5.4",
+        "@types/lodash-es": "^4.17.12",
+        "@types/semver": "^7.7.1",
+        "eslint": "^10.0.2",
+        "typescript": "^5.8.3"
+    },
+    "keywords": [
+        "reddit",
+        "devvit"
+    ],
+    "peerDependencies": {
+        "@devvit/protos": "^0.14.6",
+        "@devvit/reddit": "^0.14.6",
+        "@devvit/shared-types": "^0.14.6",
+        "@devvit/web": "^0.14.6"
+    }
+}

package/tsconfig.build.json

@@ -1,15 +1,15 @@
-{
-    "extends": "./tsconfig.json",
-    "exclude": [
-        "vitest.config.ts",
-        "node_modules",
-        "tests",
-        "dist",
-        "eslint.config.mjs"
-    ],
-    "compilerOptions": {
-        "rootDir": "src",
-        "outDir": "dist",
-        "skipLibCheck": true
-    }
-}
+{
+    "extends": "./tsconfig.json",
+    "exclude": [
+        "vitest.config.ts",
+        "node_modules",
+        "tests",
+        "dist",
+        "eslint.config.mjs"
+    ],
+    "compilerOptions": {
+        "rootDir": "src",
+        "outDir": "dist",
+        "skipLibCheck": true
+    }
+}