program overview

Service to handle a “program” execution.

Added in v2.0.0

---

Table of contents

• capabilities
  • ProgramSvc (interface)
• instances
  • program
• model
  • Effect (interface)
  • Program (interface)

---

capabilities

ProgramSvc (interface)

Signature

export interface ProgramSvc {
  program: Program;
}

Added in v2.0.0

instances

program

Live instance of Program service.

Signature

export declare const program: () => Program;

Added in v2.0.0

model

Effect (interface)

Defines an “effect” as an asyncronous operation that can fail (with an Error) or succeed with some value (void by default).

Signature

export interface Effect<A = void> extends TaskEither<Error, A> {}

Added in v2.0.0

Program (interface)

Defines the Program service capabilities.

Signature

export interface Program {
  run: (p: Effect) => Promise<void>;
}

Added in v2.0.0