Symbol documentation

src/Crypto.ts

@@ -1,9 +1,23 @@
 import { Iron } from '../deps.ts'
 
+/** 
+ * Encrypt a string or object value
+ * 
+ * @param password Random string at least 32 characters long
+ * @param payload String or object to encrypt
+ * @returns A promise of the encrypted string
+ */
 export async function encrypt(password: string, payload: object | string): Promise<string> {
   return await Iron.seal(globalThis.crypto, payload, password, Iron.defaults)
 }
 
+/**
+ * Decrypt an encrypted payload
+ * 
+ * @param password Random string at least 32 characters long
+ * @param encrypted Encrypted string
+ * @returns Promise of the unencrypted value (string or object in most cases)
+ */
 export async function decrypt(password:string, encrypted: string): Promise<unknown> {
   return await Iron.unseal(globalThis.crypto, encrypted, {default: password}, Iron.defaults)
 }

src/Middleware.ts

@@ -13,6 +13,7 @@ interface SessionOptions {
   sessionCookieName?: string
 }
 
+/** Function that returns a Hono-compatible session middleware */
 export function sessionMiddleware(options: SessionOptions): MiddlewareHandler<any, any, {}> {
 
   const store = options.store

src/Session.ts

@@ -3,13 +3,19 @@ interface SessionDataEntry {
   flash: boolean
 }
 
+/**
+ * Interface for specifying the necessary data for a session entry
+ */
 export interface SessionData {
   _data: Record<string, SessionDataEntry>,
   _expire: string | null,
   _delete: boolean,
   _accessed: string | null,
 }
 
+/**
+ * Session class with methods for interacting with the session
+ */
 export class Session {
 
   private cache: SessionData

src/store/CookieStore.ts

@@ -6,6 +6,10 @@ interface CookieStoreOptions {
   cookieOptions?: CookieOptions,
   sessionCookieName: string
 }
+
+/**
+ * Cookie storage driver class
+ */
 class CookieStore {
   public encryptionKey: string | null | undefined
   public cookieOptions: CookieOptions | undefined

src/store/MemoryStore.ts

@@ -1,6 +1,9 @@
 import Store from './Store.ts'
 import { SessionData } from '../../mod.ts'
 
+/**
+ * Memory storage driver class
+ */
 class MemoryStore implements Store {
   private data: Map<string, SessionData>
 

src/store/Store.ts

@@ -1,5 +1,8 @@
 import { SessionData } from "../../mod.ts"
 
+/**
+ * Interface for required methods in session storage drivers
+ */
 export default interface Store {
   getSessionById(sessionId?: string) : SessionData | null | undefined | Promise<SessionData | null | undefined>
   createSession(sessionId: string, initialData: SessionData) : Promise<void> | void