Search

CAP Service SDK for Node.js

Reference Documentation

We use the following conventions to describe method signatures.
Example:

cds.connect.to (service, options?) service
cds.serve (service) … service
.from (model)
.at (path)

Legend:

  • param? — appended question marks denote optional parameters
  • result — solid line arrows: returns the given result
  • result — dashed arrows: returns a [Promise] resolving to the given result
  • ... — denotes a fluent API, eventually returning/resolving to given result
  • — denotes subsequent methods to add options in a fluent API