mogli@0.3.3

Modules

cleanupState(state) ⇒ State: Removes unserializable keys from the state.
lookup(relationshipName, externalID, path) ⇒ object: Adds a lookup or 'dome insert' to a record.
relationship(relationshipName, externalID, dataSource) ⇒ object: Adds a lookup or 'dome insert' to a record.

Removes unserializable keys from the state.

Kind: global function

Param	Type
state	`State`

Adds a lookup or 'dome insert' to a record.

Kind: global function

Param	Type	Description
relationshipName	`string`	`__r` relationship field on the record.
externalID	`string`	Salesforce ExternalID field.
path	`string`	JSONPath to data source.

Example (Example)

lookup("relationship_name__r", "externalID on related object", "$.path")

Adds a lookup or 'dome insert' to a record.

Kind: global function

Param	Type	Description
relationshipName	`string`	`__r` relationship field on the record.
externalID	`string`	Salesforce ExternalID field.
dataSource	`string`	resolvable source.

Example (Data Sourced Value)

relationship("relationship_name__r", "externalID on related object", dataSource("path"))

Example (Fixed Value)

relationship("relationship_name__r", "externalID on related object", "hello world")

Kind: global typedef
Properties

Name	Type	Description
data	`object`	JSON Data.
references	`Array.<Reference>`	History of all previous operations.

Kind: global typedef

Param	Type
state	`State`