Type Alias: CustomEventBooleanConfig

@torque-labs/torque-utilsDocs


@torque-labs/torque-utils / CustomEventBooleanConfig

Type Alias: CustomEventBooleanConfig

type CustomEventBooleanConfig: {
  description: null | string;
  image: null | string;
  label: null | string;
  name: string;
 } & {
  type: "boolean";
  validation: {
     match: null | boolean;
    };
};

Custom event config type for boolean properties

Type declaration

Name
Type
Description

description?

null | string

A short description to the user of the custom event field

image?

null | string

An image to display with the custom event field in the UI (eg. screenshots)

label?

null | string

The label for the custom field that will displayed in the UI

name

string

The name of the custom field

Type declaration

Name
Type
Description

type

"boolean"

Boolean custom event field type

validation

{ match: null | boolean; }

Validation for this custom event boolean property

validation.match?

null | boolean

A specific boolean value to match against (eg. true)

Defined in

types/custom-events/events.ts:116

Last updated