npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@raincatcher/datasync-cloud

v1.1.2

Published

Raincatcher DataSync cloud

Downloads

81

Readme

RainCatcher Sync Cloud

Raincatcher wrapper for Feedhenry DataSync server. This module creates server side service that allows mobile applications to sync offline data to preferred database. By default server connects and stores all client data in mongodb database. This behavior can be changed by providing custom handlers.

For advanced usage see FeedHenry Sync documentation.

Note: Cloud service is utilized by one of the sync clients. See datasync-js

Quick start

  1. Start sync service process

Starting sync service will monitor and process mew tasks are sent from sync clients

import SyncServer, { SyncApi, SyncExpressMiddleware, SyncOptions } from '@raincatcher/datasync-cloud';
const sync: SyncApi = SyncServer;

// Connect sync
const connectOptions: SyncOptions = {
  // Use intelisense to get list of options
};
sync.connect(connectOptions, function(err) {
  if (err) {
    console.log(err);
  }
});
  1. Create api endpoint for sync.

This endpoint will be called by all clients that wish to synchronize their local data with server.

//middleware
app.use(bodyParser.json());
app.use(cors());

// Use api path of your wish
// Same endpoint needs to be configured in js client
const path = '/sync/:datasetId';
const middleware: SyncExpressMiddleware = new SyncExpressMiddleware();

const router = middleware.createSyncExpressRouter();
app.use('/', router);

See example app for complete runnable example.

Accessing underlying sync library

For advanced use cases developers can access sync library using sync namespace. Library is shipped with their own typings. You can import this directly into your application as below:

import { sync } from '../src/index'
sync.anyapicall(...) ;

Where anyapicall is one of the types defined in: https://github.com/feedhenry/fh-sync/blob/master/types/fh-sync.d.ts

For more advanced usages please follow FeedHenry sync documentation

Overriding sync filter on server

By default sync clients can specify any type of filter and efectivelly get access to every record for dataset. If you wish to disable user query_filters for certain datasets for security reasons userMapperMiddleware should be used, before mounting sync express router.