Git Product home page Git Product logo

firemelon's Introduction

Firemelon

NPM version Test

A simple way to sync between WatermelonDB and Firestore.

Installation

Using npm :

$ npm install firemelon

Using yarn :

$ yarn add firemelon

Compatibility

Firemelon works with both @firebase/firestore and @react-native-firebase/firestore

Usage

import { syncFireMelon } from 'firemelon';

async () => {
    await syncFireMelon(database, syncObject, firestore, sessionId, timefn());
};
  • database : The WatermelonDB database to be synced.

  • syncObject : An object in which the synced collections and there options are

Example:

const syncObject = {
    // collections to sync
    todos: {
        // (optional)
        excludedFields: ['color', 'userId'],

        // To provide extra filters in queries. (optional)
        customQuery: firestore.collection('todos').where('color', '==', 'red'),
    },

    users: {},
};
  • firestore : The Firestore module used in the app.

  • sessionId : A unique ID for each session to prevent the function from pulling its own pushed changes.

  • timefn() :

    A custom function to provide a date for the sync time. default is new Date().

    This is an example of a more accurate way :

    const timefn = () => firestore.FieldValue.serverTimestamp();

firemelon's People

Contributors

ali-nahhas avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.