Is there a list of ALL of the available Sync config javascript parms and functions?

peter.robbins · August 1, 2018, 1:48pm

Is there documentation anywhere that describes all of the available functions for use within the Sync configuration of the Sync Gateways JSON file? For example, here is that file in the travel-mobile github.

github.com

couchbaselabs/mobile-travel-sample/blob/dd06878ae109e00dcefe59d57fd271704092d1fc/sync-gateway-config-travelsample.json

{
  "interface":":4984",
  "log": ["*"],
  "databases": {
    "travel-sample": {
      "import_docs": "continuous",
      "unsupported": {
        "enable_extended_attributes": true,
        "replicator_2":true
      },
      "bucket":"travel-sample",
      "server": "http://localhost:8091",
      "enable_shared_bucket_access":true,
      "import_filter": `
        function(doc) {
          /* Just ignore all the static travel-sample files */
           if (doc._deleted == true ) {
	      return true;
        }
           if (doc.type == "landmark" || doc.type == "hotel" || doc.type == "airport" || doc.type =="airline" || doc.type == "route") {

This file has been truncated. show original

Basically, I’m referring to all of the parameters and available function overrides within the function sync(doc, oldDoc) { } of that configuration file.

Side-Note: In our own proof of concept project, we have an extremely short Sync function that only assigns the channel to incoming docs.

peter.robbins · August 1, 2018, 2:03pm

It might be easier if I re-word the ultimate question:

Are there any parameters or functions available within the Sync configuration javascript that are NOT provided in that example. There are a lot of parms and functions shown in use there, but just wanting to know if there are additional ones not represented in that sample app. I am aware of this page : https://developer.couchbase.com/documentation/mobile/2.0/guides/sync-gateway/sync-function-api-guide/index.html but it does not appear to have everything that is accessible from within that Sync function. For example, IsDelete() and IsCreate() are not described there but are present in the sample.

traun · August 1, 2018, 5:49pm

For example, IsDelete() and IsCreate() are not described there but are present in the sample.

Those are just convenience functions that were refactored out of the sync function in the travel sample, but you can basically ignore them, because it has nothing to do with the Javascript API calls that Sync Gateway provides – I mean api calls like channel(), requireUser(), requireRole(), etc, that are all documented here: https://developer.couchbase.com/documentation/mobile/current/guides/sync-gateway/sync-function-api-guide/index.html

I don’t know of an easy way to find out if the travel sample uses every single Javascript API call that Sync Gateway provides, but I doubt it. I would look at the API docs as the reference.