@coherentglobal/spark-execute-sdk 0.7.3 → 0.8.0

package/README.md

@@ -117,6 +117,42 @@ const response = await Spark.execute(input, version_id).catch((err) => {
 });
 ```
 
+### executeWithCancellationToken(input)
+
+Perform the calculation with cancellationToken. The sdk will use the request_meta.version_uuid of input argument to locate the model
+
+```js
+const execute = Spark.executeWithCancellationToken(input)
+
+// Cancel the execution (best effort)
+execute.cancellationToken.cancel()
+
+execute.response.then((result) => {
+  // Do something here
+})
+.catch((err) => {
+  // Do something here
+  // If error is instance of Spark.WasmRunnerErrors.ExecuteCancelled, meaning the request has been cancelled
+});
+```
+
+or
+
+```js
+const execute = Spark.executeWithCancellationToken(input)
+
+// Cancel the execution (best effort)
+execute.cancellationToken.cancel()
+
+execute.response.then((result) => {
+  // Do something here
+})
+.catch((err) => {
+  // Do something here
+  // If error is instance of Spark.WasmRunnerErrors.ExecuteCancelled, meaning the request has been cancelled
+});
+```
+
 Note: The second parameter (version_id) is optional if version_id is already included on request_meta
 
 ### Sample Input