# API `@deepkit/workflow`

```shell
npm install @deepkit/workflow
```

## API reference of @deepkit/workflow

### createWorkflow (function)

```typescript
<T extends WorkflowPlaces>(name: string, definition: T, transitions?: WorkflowTransitions<T>): WorkflowDefinition<T> & WorkflowDefinitionEvents<T>
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L214

### WorkflowEvent (class)

```typescript
export class WorkflowEvent extends BaseEvent {
    nextState?: any;
    nextStateEvent?: any;
    clearNext();
    /**
     * @see WorkflowNextEvent.next
     */
    next(nextState: string, event?: any);
    hasNext(): boolean;
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L23

### WorkflowPlaces (type)

```typescript
type WorkflowPlaces = { [name: string]: ClassType<WorkflowEvent> };
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L45

### WorkflowNextEvent (type)

```typescript
interface WorkflowNextEvent<T extends WorkflowPlaces> {
    nextState?: keyof T & string;

    /**
     * Schedule to apply the next workflow step when all event listeners have been called.
     */
    next<S extends keyof T & string>(nextState: S, event?: ExtractClassType<T[S]>): void;
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L47

### WorkflowDefinitionEvents (type)

```typescript
type WorkflowDefinitionEvents<T extends WorkflowPlaces> = {
    [K in keyof T & string as `on${Capitalize<K>}`]: EventToken<BaseEvent & Omit<ExtractClassType<T[K]>, 'next' | 'nextState'> & WorkflowNextEvent<T>>
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L56

### WorkflowDefinition (class)

```typescript
export class WorkflowDefinition<T extends WorkflowPlaces> {
    transitions: WorkflowTransition<T>[];
    tokens: {
        [name in keyof T]?: EventToken<any>;
    };
    next: {
        [name in keyof T]?: (keyof T & string)[];
    };
    symbol;
    constructor(public readonly name: string, public readonly places: T, transitions: WorkflowTransitions<T> = {});
    getEventToken<K extends keyof T>(name: K): EventToken<ExtractClassType<T[K]>>;
    addTransition(from: keyof T & string, to: keyof T & string, label?: string);
    create(state: keyof T & string, eventDispatcher: EventDispatcher, stopwatch: Stopwatch, injector?: InjectorContext): Workflow<T>;
    getTransitionsFrom(state: keyof T & string): (keyof T & string)[];
    buildApplier(eventDispatcher: EventDispatcher);
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L60

### WorkflowState (type)

```typescript
interface WorkflowState<T> {
    get(): keyof T & string;

    set(v: keyof T & string): void;
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L222

### WorkflowStateSubject (class)

```typescript
export class WorkflowStateSubject<T extends WorkflowPlaces> implements WorkflowState<T> {
    constructor(public value: keyof T & string);
    get();
    set(v: keyof T & string);
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L228

### WorkflowError (error)

```typescript
export class WorkflowError extends CustomError {
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L241

### Workflow (class)

```typescript
export class Workflow<T extends WorkflowPlaces> {
    constructor(public definition: WorkflowDefinition<T>, public state: WorkflowState<T>, private eventDispatcher: EventDispatcher, private injector: InjectorContext, private stopwatch: Stopwatch);
    can(nextState: keyof T & string): boolean;
    /**
     * @throws WorkflowError when next state is not possible to apply.
     */
    apply<K extends keyof T>(nextState: K, event?: ExtractClassType<T[K]>): Promise<void>;
    isDone(): boolean;
}
```

Source: https://github.com/deepkit/deepkit-framework/blob/master/packages/workflow/src/workflow.ts#L244