DocumentService

DocumentService is a robust Luau library designed for managing data persistence in Roblox games using DataStores. It provides a schematized, type-safe approach to handling both session-locked player data and non-session-locked shared data, ensuring reliability and developer productivity.

Key Features

• Fully Typed API — Offers full intellisense and typechecking for data and API methods, including error handling.
• Rust-Inspired Error Handling — Utilizes Result types for superior error management.
• Immutable Cache — Prevents bugs caused by concurrent updates interfering with each other.
• Automatic Saves — Handles auto-saves and BindToClose saves automatically.
• Migrations — Supports data migrations, inspired by nezuo's Lapis.
• Data Validation — Validates data with runtime and static typechecking support.
• Session Flexibility — Documents can be session-locked or not, allowing multi-server editing.
• Signals & Hooks — Provides signals to tap into when operations start and finish.
• Automatic Retries — Implements retries with exponential backoff for robustness.
• JSON Storage Checks — Ensures data can be stored in JSON to avoid silent errors.
• Dependency Injection — Supports DataStore dependency injection for using any Mock DataStore.

Philosophy

DocumentService emphasizes strict typing, high code quality, and production-ready reliability, drawing inspiration from existing libraries while addressing their limitations to meet modern Roblox development needs.