Module: Adaptor

Classes

bulk
create
createIf
describe
destroy
query
retrieve
update
upsert
upsertIf
describe
relationship

Methods

(static) reference(state) → {State}

Creates a connection.
Parameters:
Name Type Description
state State Runtime state.
Source:
Returns:
Type
State
Example
createConnection(state)

(inner) cleanupState(state) → {State}

Removes unserializable keys from the state.
Parameters:
Name Type Description
state State
Source:
Returns:
Type
State
Example
cleanupState(state)

(inner) execute(…operations) → {State}

Executes an operation.
Parameters:
Name Type Attributes Description
operations Operation <repeatable>
 Operations
Source:
Returns:
Type
State

(inner) login(state) → {State}

Performs a login.
Parameters:
Name Type Description
state State Runtime state.
Source:
Returns:
Type
State
Example
login(state)

(inner) steps() → {Array}

Flattens an array of operations.
Source:
Returns:
Type
Array
Example
steps(
  createIf(params),
  update(params)
)

Type Definitions

Operation(state)

Parameters:
Name Type Description
state State
Source:

State

Type:
  • Object
Properties:
Name Type Description
data object JSON Data.
references Array.<Reference> History of all previous operations.
Source: