feat: add presets to simplify use

Author: typicode

src/examples/browser.ts

@@ -1,13 +1,12 @@
-import { LocalStorage } from '../browser.js'
-import { LowSync } from '../index.js'
+import { WebStoragePreset } from '../presets/WebStoragePreset.js'
 
 type Data = {
   messages: string[]
 }
-const adapter = new LocalStorage<Data>('db')
-const db = new LowSync<Data>(adapter, { messages: [] })
 
-db.read()
+const defaultData: Data = { messages: [] }
+const db = WebStoragePreset<Data>('db', defaultData)
+
 db.data.messages.push('foo')
 
 db.write()

src/examples/cli.ts

@@ -1,16 +1,12 @@
-import { LowSync } from '../index.js'
-import { JSONFileSync } from '../node.js'
+import { JSONSyncPreset } from '../presets/JSONPreset.js'
 
 type Data = {
   messages: string[]
 }
 
 const message = process.argv[2] || ''
 const defaultData: Data = { messages: [] }
-const adapter = new JSONFileSync<Data>('file.json')
-const db = new LowSync<Data>(adapter, defaultData)
-
-db.read()
+const db = JSONSyncPreset('file.json', defaultData)
 
 db.data.messages.push(message)
 

src/examples/server.ts

@@ -4,8 +4,7 @@
 import express from 'express'
 import asyncHandler from 'express-async-handler'
 
-import { Low } from '../index.js'
-import { JSONFile } from '../node.js'
+import { JSONPreset } from '../presets/JSONPreset.js'
 
 const app = express()
 app.use(express.json())
@@ -19,9 +18,8 @@ type Data = {
   posts: Post[]
 }
 
-const adapter = new JSONFile<Data>('db.json')
-const db = new Low<Data>(adapter, { posts: [] })
-await db.read()
+const defaultData: Data = { posts: [] }
+const db = await JSONPreset<Data>('db.json', defaultData)
 
 // db.data can be destructured to avoid typing `db.data` everywhere
 const { posts } = db.data

src/presets/JSONPreset.ts

@@ -0,0 +1,31 @@
+import { Memory, MemorySync } from '../adapters/Memory.js'
+import { JSONFile, JSONFileSync } from '../adapters/node/JSONFile.js'
+import { Low, LowSync } from '../core/Low.js'
+
+export async function JSONPreset<Data>(
+  filename: string | URL,
+  defaultData: Data,
+  dir?: string | URL,
+): Promise<Low<Data>> {
+  const adapter =
+    process.env.NODE_ENV === 'test'
+      ? new Memory<Data>()
+      : new JSONFile<Data>(new URL(filename, dir))
+  const db = new Low<Data>(adapter, defaultData)
+  await db.read()
+  return db
+}
+
+export function JSONSyncPreset<Data>(
+  filename: string | URL,
+  defaultData: Data,
+  dir?: string | URL,
+): LowSync<Data> {
+  const adapter =
+    process.env.NODE_ENV === 'test'
+      ? new MemorySync<Data>()
+      : new JSONFileSync<Data>(new URL(filename, dir))
+  const db = new LowSync<Data>(adapter, defaultData)
+  db.read()
+  return db
+}

src/presets/WebStoragePreset.ts

@@ -0,0 +1,13 @@
+import { WebStorage } from '../adapters/browser/WebStorage.js'
+import { LowSync } from '../index.js'
+
+export function WebStoragePreset<Data>(
+  key: string,
+  defaultData: Data,
+  storage: Storage = localStorage,
+) {
+  const adapter = new WebStorage<Data>(key, storage)
+  const db = new LowSync<Data>(adapter, defaultData)
+  db.read()
+  return db
+}