# conductor-javascript

> Typescript Client for Netflix Conductor

Latest version **0.0.6** (published 2022-09-16) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install conductor-javascript
pnpm add conductor-javascript
yarn add conductor-javascript
bun add conductor-javascript
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2022-09-16 |
| First published | 2022-08-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16 |
| Dependencies | 1 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Conductor community |
| Maintainers | io-orkes |
| Keywords | conductor, workflow, orchestration, microservice |

## Links

- npm: https://www.npmjs.com/package/conductor-javascript
- Repository: https://github.com/conductor-sdk/conductor-typescript
- Homepage: https://orkes.io
- Issues: https://github.com/conductor-sdk/conductor-typescript/issues
- npm.io page: https://npm.io/package/conductor-javascript

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2022-09-16
- 0.0.5 — 2022-08-31
- 0.0.4 — 2022-08-23

## README

# Conductor Javascript SDK

This project provides client SDKs to interact with [Netflix](https://conductor.netflix.com/) and [Orkes](https://orkes.io/) conductor servers.

## Quick Start

1. [Setup](#Setup-conductor)
2. [Create and run Task Workers](docs/worker/README.md)
3. [Create workflows using Code](docs/workflow/README.md)
4. [Api Docs](docs/api/README.md)

### Setup conductor

Simple connection to conductor

```typescript
const client = new ConductorClient({
  serverUrl: "https://play.orkes.io/api",
});

```
#### Using TLS

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: "<buffer>",
  cert: "<buffer>",
  ca: "<buffer>",
  servername: 'play.orkes.io',
  // ...
}

const client = new ConductorClient({
  serverUrl: 'https://play.orkes.io/api',
  AGENT: new Agent(agentOptions)
})

const taskManager = new TaskManager(client, [ /* workers */ ])
taskManager.startPolling()
```

#### Connect to conductor using Orkes

```typescript

/**
 * Application keys generated from the Application menu > Create Application
 * then edit and create Access Keys
 *
 */
import { OrkesApiConfig, orkesConductorClient } from "@io-orkes/conductor-typescript";

const config: Partial<OrkesApiConfig> = {
  keyId: "XXX",
  keySecret: "XXXX",
  serverUrl: "https://play.orkes.io/api",
};

orkesConductorClient(config).then(client => ..... );

```

---
_Source: https://npm.io/package/conductor-javascript · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
