feat(jsdoc): add jsdoc

Author: MonsterDeveloper

src/cache-key.ts

@@ -1,3 +1,10 @@
+/**
+ * Composes a cache key by optionally prefixing it with a namespace
+ *
+ * @param key - The base cache key
+ * @param keyPrefix - Optional prefix to namespace the cache key
+ * @returns The final cache key, either prefixed (`prefix:key`) or unchanged
+ */
 export function buildCacheKey(key: string, keyPrefix?: string) {
   return keyPrefix ? `${keyPrefix}:${key}` : key
 }

src/drivers/better-sqlite3.ts

@@ -3,6 +3,16 @@ import type { Database } from "better-sqlite3"
 import { buildCacheKey } from "../cache-key"
 import type { CachifiedAdapterSqliteOptions } from "../index"
 
+/**
+ * Creates a better-sqlite3 cache adapter for use with cachified
+ *
+ * @param options - {@linkcode CachifiedAdapterSqliteOptions} plus a database instance
+ * @param options.database - The better-sqlite3 database instance
+ * @param options.tableName - Name of the table to store cache entries
+ * @param options.keyPrefix - Optional prefix to namespace cache keys
+ * @param options.name - Optional name for the cache adapter
+ * @returns A Cache instance that stores data in SQLite using better-sqlite3
+ */
 export function betterSqlite3CacheAdapter<Value = unknown>(
   options: CachifiedAdapterSqliteOptions & {
     database: Database
@@ -64,6 +74,12 @@ export function betterSqlite3CacheAdapter<Value = unknown>(
   }
 }
 
+/**
+ * Creates a cache table in the SQLite database if it doesn't already exist
+ *
+ * @param database - The better-sqlite3 Database instance
+ * @param tableName - Name of the cache table to create
+ */
 export function createBetterSqlite3CacheTable(
   database: Database,
   tableName: string,

src/drivers/bun.ts

@@ -3,6 +3,16 @@ import { type Cache, totalTtl } from "@epic-web/cachified"
 import { buildCacheKey } from "../cache-key"
 import type { CachifiedAdapterSqliteOptions } from "../index"
 
+/**
+ * Creates a Bun SQLite cache adapter for use with cachified
+ *
+ * @param options - {@linkcode CachifiedAdapterSqliteOptions} plus a database instance
+ * @param options.database - The Bun SQLite database instance
+ * @param options.tableName - Name of the table to store cache entries
+ * @param options.keyPrefix - Optional prefix to namespace cache keys
+ * @param options.name - Optional name for the cache adapter
+ * @returns A Cache instance that stores data in SQLite using Bun's SQLite driver
+ */
 export function bunSqliteCacheAdapter<Value = unknown>(
   options: CachifiedAdapterSqliteOptions & {
     database: Database
@@ -62,6 +72,12 @@ export function bunSqliteCacheAdapter<Value = unknown>(
   }
 }
 
+/**
+ * Creates a cache table in the SQLite database if it doesn't already exist
+ *
+ * @param database - The Bun SQLite Database instance
+ * @param tableName - Name of the cache table to create
+ */
 export function createBunSqliteCacheTable(
   database: Database,
   tableName: string,

src/drivers/sqlite.ts

@@ -3,6 +3,16 @@ import type { Database } from "sqlite"
 import { buildCacheKey } from "../cache-key"
 import type { CachifiedAdapterSqliteOptions } from "../index"
 
+/**
+ * Creates a sqlite cache adapter for use with cachified
+ *
+ * @param options - {@linkcode CachifiedAdapterSqliteOptions} plus a database instance
+ * @param options.database - The sqlite database instance
+ * @param options.tableName - Name of the table to store cache entries
+ * @param options.keyPrefix - Optional prefix to namespace cache keys
+ * @param options.name - Optional name for the cache adapter
+ * @returns A Cache instance that stores data in SQLite using sqlite
+ */
 export function sqliteCacheAdapter<Value = unknown>(
   options: CachifiedAdapterSqliteOptions & {
     database: Database
@@ -64,6 +74,12 @@ export function sqliteCacheAdapter<Value = unknown>(
   }
 }
 
+/**
+ * Creates a cache table in the SQLite database if it doesn't already exist
+ *
+ * @param database - The sqlite Database instance
+ * @param tableName - Name of the cache table to create
+ */
 export function createSqliteCacheTable(database: Database, tableName: string) {
   return database.exec(`CREATE TABLE IF NOT EXISTS ${tableName} (
     key TEXT PRIMARY KEY,

src/drivers/sqlite3.ts

@@ -3,6 +3,16 @@ import type { Database } from "sqlite3"
 import { buildCacheKey } from "../cache-key"
 import type { CachifiedAdapterSqliteOptions } from "../index"
 
+/**
+ * Creates a sqlite3 cache adapter for use with cachified
+ *
+ * @param options - {@linkcode CachifiedAdapterSqliteOptions} plus a database instance
+ * @param options.database - The sqlite3 database instance
+ * @param options.tableName - Name of the table to store cache entries
+ * @param options.keyPrefix - Optional prefix to namespace cache keys
+ * @param options.name - Optional name for the cache adapter
+ * @returns A Cache instance that stores data in SQLite using sqlite3
+ */
 export function sqlite3CacheAdapter<Value = unknown>(
   options: CachifiedAdapterSqliteOptions & {
     database: Database
@@ -95,6 +105,12 @@ export function sqlite3CacheAdapter<Value = unknown>(
   }
 }
 
+/**
+ * Creates a cache table in the SQLite database if it doesn't already exist
+ *
+ * @param database - The sqlite3 Database instance
+ * @param tableName - Name of the cache table to create
+ */
 export async function createSqlite3CacheTable(
   database: Database,
   tableName: string,

src/index.ts

@@ -3,8 +3,14 @@ export * from "./drivers/sqlite"
 export * from "./drivers/better-sqlite3"
 export * from "./drivers/bun"
 
+/**
+ * Common options for all SQLite-based cache adapters
+ */
 export type CachifiedAdapterSqliteOptions = {
+  /** The name of the table to store cache entries */
   tableName: string
+  /** Optional prefix to namespace cache keys */
   keyPrefix?: string
+  /** Cache adapter name */
   name?: string
 }