chore: added additional documentation

README.md

@@ -91,7 +91,7 @@ _Supported Deno verisons:_ **^1.40.0**
     - [flat()](#flat)
   - [Extensions](#extensions)
     - [Zod](#zod)
-      - [`zodModel()`](#zodmodel)
+      - [zodModel()](#zodmodel)
       - [Schemas](#schemas)
     - [Migrate](#migrate)
       - [Script](#script)
@@ -1241,7 +1241,9 @@ some dependenices to enhance integration. All extensions are found in the
 
 ### Zod
 
-#### `zodModel()`
+Extended support for Zod. Includes a model parser and schemas for some KV-types.
+
+#### zodModel()
 
 Provides additional compatibility when using zod schemas as models. While zod
 schemas can be used as models directly, `zodModel()` properly parses a model

ext/zod.ts

@@ -3,7 +3,7 @@
  *
  * Extended support for Zod. Includes a model parser and schemas for some KV-types.
  *
- * ## `zodModel()`
+ * ## zodModel()
  *
  * Provides additional compatibility when using zod schemas as models. While zod
  * schemas can be used as models directly, `zodModel()` properly parses a model

src/atomic_pool.ts

@@ -1,5 +1,6 @@
 import type { AtomicSetOptions } from "./types.ts"
 
+/** Holds atomic mutations in a pool until bound to an actual atomic operation */
 export class AtomicPool implements Deno.AtomicOperation {
   private pool: Array<(op: Deno.AtomicOperation) => Deno.AtomicOperation>
 

src/atomic_wrapper.ts

@@ -5,6 +5,10 @@ import {
 } from "./constants.ts"
 import type { AtomicSetOptions } from "./types.ts"
 
+/**
+ * Implements the AtomicOperation interface and automatically executes
+ * batched operations using a dynamic attributes such as count and size.
+ */
 export class AtomicWrapper implements Deno.AtomicOperation {
   private kv: Deno.Kv
   private atomics: Deno.AtomicOperation[]

src/collection.ts

@@ -134,6 +134,7 @@ export function collection<
     )
 }
 
+/** Represents a collection of documents and provides methods for handling them, alongside queues. */
 export class Collection<
   const TInput,
   const TOutput extends KvValue,

src/document.ts

@@ -9,13 +9,13 @@ import type {
 } from "./types.ts"
 import { isKvObject } from "./utils.ts"
 
+/** Represents a database entry with id, versionstamp and value. */
 export class Document<const TOutput extends KvValue> {
   readonly id: KvId
   readonly versionstamp: KvVersionstamp<TOutput>
   readonly value: TOutput
 
   constructor(
-    // deno-lint-ignore no-explicit-any
     model: Model<any, TOutput>,
     { id, versionstamp, value }: DocumentData<TOutput>,
   ) {

src/errors.ts

@@ -1,3 +1,4 @@
+/** Error representing the use, selection or creation of an invalid collection in a given context. */
 export class InvalidCollectionError extends Error {
   constructor(message?: string, options?: ErrorOptions) {
     super(message, options)

src/kvdex.ts

@@ -119,6 +119,7 @@ export function kvdex<const T extends SchemaDefinition>(
   return Object.assign(db, schema)
 }
 
+/** Represents a database instance and contains methods for working on all documents and top-level queues. */
 export class Kvdex<const TSchema extends Schema<SchemaDefinition>> {
   private kv: Deno.Kv
   private schema: TSchema

src/types.ts

@@ -315,7 +315,14 @@ export type ParseInputType<TInput, TOutput extends KvValue> = TInput extends
  * Contains a parse function, and optionally a __validate function used instead of parse upon reading data.
  */
 export type Model<TInput, TOutput extends KvValue> = {
+  /** A parse function that takes an input type and returns an output type */
   parse: (data: TInput) => TOutput
+
+  /**
+   * An optional validate function that takes any input value and returns an output type.
+   *
+   * Is used instead of `parse()` upon reading a document.
+   */
   __validate?: (data: unknown) => TOutput
 }