feat: allow connection redis options to be passed directly to constru…

…ctor (#8)
tinacms · Nov 16, 2023 · 88829ad · 88829ad
1 parent 90c47d0
commit 88829ad
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 14 deletions.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "upstash-redis-level",
   "description": "@upstash/redis backed abstract-level database for Node.js",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",

diff --git a/src/index.test.ts b/src/index.test.ts
@@ -14,7 +14,6 @@
 
 import {RedisLevel} from './index'
 import 'isomorphic-fetch'
-import {Redis} from '@upstash/redis'
 
 const ModuleError = require('module-error')
 
@@ -23,21 +22,17 @@ const keyNotFoundError = (key: string) => new ModuleError(`Key ${key} was not fo
 })
 
 describe('redis-level', () => {
-  let redis: Redis
   let level: RedisLevel
-  beforeEach(() => {
-    redis = new Redis({
-      url: process.env.UPSTASH_REDIS_REST_URL || 'http://localhost:8079',
-      token: process.env.UPSTASH_REDIS_REST_TOKEN || 'mytoken',
-      automaticDeserialization: true,
-    })
-  })
 
   describe('json encoding', () => {
     let namespace = `test-${Math.random()}`
     beforeEach(async () => {
       level = new RedisLevel<string, string>({
-        redis,
+        redis: {
+          url: process.env.UPSTASH_REDIS_REST_URL || 'http://localhost:8079',
+          token: process.env.UPSTASH_REDIS_REST_TOKEN || 'mytoken',
+          automaticDeserialization: true,
+        },
         namespace,
         keyEncoding: 'json',
         valueEncoding: 'json',
@@ -62,7 +57,11 @@ describe('redis-level', () => {
   describe('default encoding', () => {
     beforeEach(async () => {
       level = new RedisLevel<string, string>({
-        redis,
+        redis: {
+          url: process.env.UPSTASH_REDIS_REST_URL || 'http://localhost:8079',
+          token: process.env.UPSTASH_REDIS_REST_TOKEN || 'mytoken',
+          automaticDeserialization: true,
+        },
         namespace: `test-${Math.random()}`
       })
     })

diff --git a/src/index.ts b/src/index.ts
@@ -35,9 +35,16 @@ const encodeFilter = (filter: string) => {
   }
   return encodeURIComponent(filter)
 }
+
+type RedisConnectionOptions = {
+  url: string
+  token: string
+  automaticDeserialization?: boolean
+}
+
 export type RedisLevelOptions<K, V> = {
+  redis: RedisConnectionOptions | Redis
   debug?: boolean
-  redis: Redis
   namespace?: string
 } & AbstractDatabaseOptions<K, V>
 
@@ -226,7 +233,11 @@ export class RedisLevel<KDefault = string, VDefault = string> extends AbstractLe
 
   constructor(options: RedisLevelOptions<KDefault, VDefault>) {
     super({ encodings: { utf8: true }, snapshots: false }, options)
-    this.redis = options.redis
+    this.redis = (typeof options.redis === 'object' &&
+      'hmget' in options.redis &&
+      typeof options.redis.hmget === 'function') ?
+      options.redis as Redis :
+      new Redis(options.redis as RedisConnectionOptions)
     const namespace = options.namespace || 'level'
     this.hKey = `${namespace}:h`
     this.zKey = `${namespace}:z`