@Description

Sets a short localised description

Sets a short localised description shown in the platform UI. Accepts multiple translations.

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

Signature

@Description(...translations: Translation[]): ClassDecorator

Example

@Description(
  { code: 'en-US', content: 'Computes the n-th Fibonacci number' },
)
export class FibonacciFunction extends FibonacciRuntimeFunction {}

Applies to

Function, RuntimeFunction, Event, RuntimeEvent

@Name

Sets the localised display name

@Documentation

Sets long-form documentation text

@Description

Signature

Example

Applies to

On this page