From 18724bde85cd65bbc990d399e90fa2d92911b231 Mon Sep 17 00:00:00 2001 From: Najeeb Date: Thu, 6 Apr 2023 17:15:07 +0530 Subject: [PATCH 1/3] readme-update: removed agentOptions --- README.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/README.md b/README.md index adaf65d5..7b3bac81 100644 --- a/README.md +++ b/README.md @@ -24,20 +24,10 @@ const client = new ConductorClient({ The client uses `node-fetch` which supports node.js's [`httpsAgent` options](https://nodejs.org/api/https.html#new-agentoptions). For example: ```typescript -import {Agent} from "https" import {ConductorClient} from "@io-orkes/conductor-typescript"; -const agentOptions = { - key: "", - cert: "", - ca: "", - servername: 'play.orkes.io', - // ... -} - const client = new ConductorClient({ serverUrl: 'https://play.orkes.io/api', - AGENT: new Agent(agentOptions) }) const taskManager = new TaskManager(client, [ /* workers */ ]) From 5d1af7780e48fe62697e6ef1b05c0838fc577d83 Mon Sep 17 00:00:00 2001 From: James Stuart Milne Date: Thu, 6 Apr 2023 18:24:44 -0300 Subject: [PATCH 2/3] refactor: remove tls added simple explanation for custom workers --- README.md | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7b3bac81..82ded2f3 100644 --- a/README.md +++ b/README.md @@ -19,19 +19,41 @@ const client = new ConductorClient({ }); ``` -#### Using TLS -The client uses `node-fetch` which supports node.js's [`httpsAgent` options](https://nodejs.org/api/https.html#new-agentoptions). For example: +### Running Custom Workers ```typescript import {ConductorClient} from "@io-orkes/conductor-typescript"; -const client = new ConductorClient({ +const clientPromise = new ConductorClient({ serverUrl: 'https://play.orkes.io/api', }) -const taskManager = new TaskManager(client, [ /* workers */ ]) -taskManager.startPolling() +const client = await clientPromise; + +const taskManager = new TaskRunner({ + taskResource: client.taskResource, + worker: { + taskDefName: "MyCustomWorker", + execute: async ({ inputData, taskId }) => { + return { + outputData: { + greeting: "Hello World", + }, + status: "COMPLETED", + }; + }, + }, + options: { + pollInterval: 10, + domain: undefined, + concurrency: 1, + workerID: "", + }, + }); + +taskManager.startPolling(); + ``` #### Connect to conductor using Orkes From f4fadef64356fa972cba14f07cdd4386cbadd6f2 Mon Sep 17 00:00:00 2001 From: James Stuart Milne Date: Thu, 6 Apr 2023 18:29:47 -0300 Subject: [PATCH 3/3] fix: imports in readme --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 82ded2f3..d68d58ba 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,10 @@ const client = new ConductorClient({ ### Running Custom Workers ```typescript -import {ConductorClient} from "@io-orkes/conductor-typescript"; -const clientPromise = new ConductorClient({ +import { OrkesApiConfig, orkesConductorClient, TaskRunner } from "@io-orkes/conductor-javascript"; + +const clientPromise = orkesConductorClient({ serverUrl: 'https://play.orkes.io/api', }) @@ -65,7 +66,7 @@ taskManager.startPolling(); * then edit and create Access Keys * */ -import { OrkesApiConfig, orkesConductorClient } from "@io-orkes/conductor-typescript"; +import { OrkesApiConfig, orkesConductorClient } from "@io-orkes/conductor-javascript"; const config: Partial = { keyId: "XXX",