monSQLize
  • English

      • monSQLize TS Documentation

      This documentation targets the TypeScript rewrite of monSQLize (v2) and is aligned with the v1-compatible public API surface.

      Current Documentation Coverage

      TopicCurrent entryStatusNotes
      Quick start / installation / connection / basic queriesgetting-started.md✅Aligned with the current runtime and full TypeScript types
      Common recipesrecipes.md✅Copy-ready paths for basic connection, cache, Redis, SSH, pools, locks, and Model usage
      Cache / function cachecache-and-function-cache.md✅MemoryCache / withCache() / FunctionCache
      Examples mapping / galleryexamples.md✅Maps documentation topics to official examples
      Advanced capability indexCapability index✅Index of the current advanced capability surface
      Verification / architecture / engineering governanceverification-entrypoints.md / runtime-architecture.md / support-matrix.md / release-preflight.md✅Unified entry points for verification, private real-env boundaries, runtime structure, and release constraints
      1. Package entry: repository README
      2. Quick start: getting-started.md
      3. Recipes: recipes.md
      4. Cache guide: cache-and-function-cache.md
      5. Capability index: Capability index
      6. Engineering and boundaries:
      7. Runnable examples:
        • examples/README.md
        • examples/quick-start/basic-connect.ts
        • examples/cache/with-cache.ts
        • examples/docs/*.ts
        • examples.md

      Documentation Boundary

      • This directory records the formal entries that are fully owned and continuously verified in the current repository.
      • Documentation, examples, types, and tests use the current TypeScript version as the source of truth and no longer depend on the legacy external repository.

      Running Examples

      Run these commands from the repository root:

      npm run build
npm run test:examples

      Notes:

      • basic-connect.ts starts a temporary local MongoDB environment through the repository's in-memory MongoDB helper and validates the TypeScript consumption path.
      • with-cache.ts does not require MongoDB or Redis. It demonstrates the minimal current cache API usage and type signatures.