Nelkap

The client your workflows, your route, and your code use to reach Nelkap.

new Nelkap(options?: NelkapOptions)

Options

apiKey · string

An API key of your project. Defaults to NELKAP_API_KEY.

secret · string

Your project’s secret, which handle checks on each call. Defaults to NELKAP_SECRET.

apiUrl · string

The address of the Nelkap API. Defaults to NELKAP_API_URL, or https://api.nelkap.com when it isn’t set.

Methods

Method	What it does
registerWorkflows	Sets your project’s workflows and sends them to Nelkap.
run	Starts a run of a workflow.
emit	Emits an event.
handle	Answers the calls Nelkap makes to your endpoint.
step	The steps of a workflow: run, sleep, wait, and score.

Exports

import { Nelkap, NelkapError, StepError } from '@nelkap/sdk';
import type { EmitEventInput, NelkapOptions, Workflow, WorkflowHandler } from '@nelkap/sdk';