@ThrowsError

Marks a Function or RuntimeFunction as capable of throwing a RuntimeError. This signals to the platform that the error case must be handled in the flow. Defaults to true when called without arguments.

import { ThrowsError } from '@code0-tech/hercules';

Signature

@ThrowsError(throwsError?: boolean): ClassDecorator

Example

@ThrowsError()
export class ParseJsonFunction extends ParseJsonRuntimeFunction {}

import { RuntimeError } from '@code0-tech/hercules';

export class ParseJsonRuntimeFunction {
  run(context: FunctionContext, input: string): object {
    try {
      return JSON.parse(input);
    } catch {
      throw new RuntimeError('INVALID_JSON', 'The input is not valid JSON');
    }
  }
}

Applies to

Function, RuntimeFunction

@ThrowsError

Signature

Example

Applies to

On this page