@EventSetting

Adds a configurable setting to an event

Adds a configurable setting to an Event or RuntimeEvent. Apply multiple times for multiple settings — they are collected in declaration order.

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

Signature

@EventSetting(setting: EventSettingProps): ClassDecorator

See EventSettingProps for the full interface.

Example

@EventSetting({
  identifier: 'FILTER_ROLE',
  name: [{ code: 'en-US', content: 'Role Filter' }],
  description: [{ code: 'en-US', content: 'Only trigger for users with this role' }],
  optional: true,
})
@EventSetting({
  identifier: 'MIN_AGE',
  name: [{ code: 'en-US', content: 'Minimum Age' }],
  defaultValue: 18,
  optional: true,
})
export class UserCreatedRuntimeEvent {}

Applies to

Event, RuntimeEvent

@OmitRuntimeFunction

Prevents auto-generation of a public function definition from a RuntimeFunction

@OmitEvent

Prevents auto-generation of a public event definition from a RuntimeEvent

On this page