@syncmatters/script-api
v1.0.6
Published
TypeScript type definitions for the SyncMatters script API (types only - scripts execute on the SyncMatters platform)
Readme
@syncmatters/script-api
TypeScript type definitions for the SyncMatters script API.
This is a types-only package: it provides IntelliSense and type checking when developing SyncMatters integration scripts locally (for example in VS Code or Cursor). Script code executes on the SyncMatters platform, which provides the runtime implementation of this API.
Usage
import API from "@syncmatters/script-api";
/** @param {API.Context} ctx */
export async function main(ctx) {
ctx.log.info("Lets connect some systems!");
}Connector test harnesses additionally use the sdk-test entry point:
import SDKTest from "@syncmatters/script-api/sdk-test";Add "checkJs": true to your jsconfig.json to activate the JSDoc type annotations used in
script .mjs files.