Repository files navigation

Getting Started |Reference

SignalDB is a client-side database optimized for modern web applications. It provides an optimistic UI for creating responsive and dynamic interfaces, a MongoDB-like interface for familiarity, and robust TypeScript support to ensure type safety and accelerate development. SignalDB enables versatile local data persistence with support for various storage providers and facilitates real-time updates by gathering and synchronizing data from multiple sources. Its framework-agnostic design makes it suitable for projects of any scale, offering instant data access with minimal latency, which is ideal for applications requiring fast data handling and real-time interactions. Adapters are available for popular reactive libraries, includingAngular,React,Solid,Svelte andVue.js.

  $ npm install @signaldb/core

import{Collection}from'@signaldb/core'constPosts=newCollection()constpostId=Posts.insert({title:'Foo',text:'Lorem ipsum …'})Posts.updateOne({id:postId},{// updates the post$set:{title:'New title',}})Posts.removeOne({id:postId})// removes the postconstcursor=collection.find({})// returns an array with all documents in the collection// reruns automatically in a reactive contextconsole.log(cursor.fetch())

See thedocumentation for more information.

Licensed under MIT license. Copyright (c) 2024 Max Nowack

Contributions are welcome. Please open issues and/or file Pull Requests.SeeContributing.md to get started.

If you encounter any issues, there are several ways to get support.

• Join ourDiscord server.
• Start a discussion
• Open an issue