Skip to content

Commit

Permalink
Document optional getReconcileEndpoint config function
Browse files Browse the repository at this point in the history
  • Loading branch information
tylercollier committed May 23, 2022
1 parent faf69e9 commit cb68712
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions config/config.example.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,17 @@ const bridgeExample = {
return url.toString()
},

// Optional. If not specified, will use getPurgeEndpoint.
// Get the reconcile endpoint for a given MLS Resource, but meant for reconciling. This should be a function that
// returns a string.
// The function accepts two parameters:
// 1) MlsResource object, as described in the 'mlsResources' item below.
// 2) isExpandedMlsResource, a boolean which indicates if the resource is a root or was used as an $expand'ed
// resource. In the latter case, you might perhaps not want to use any $filter condition.
// Do not include a $select query string parameter; it will be overwritten with the primary key(s) of the
// resource.
// getReconcileEndpoint: (mlsResourceObj, isExpandedMlsResource) => string

// This should be the largest $top value allowed by the MLS during replication. Bridge Interactive allows 2000.
top: 2000,

Expand Down

0 comments on commit cb68712

Please sign in to comment.