Interface SchemaEnumOptions<T>

Options for filtering and representing a bound engine Enum.

interface SchemaEnumOptions<T extends Enum> {
    description?: string;
    filter?: (value: EnumValueTyped<T>, name: string) => boolean;
    transform?: (
        name: string,
        value: EnumValueTyped<T>,
    ) => SchemaEnumRepresentation;
}

Type Parameters

T extends Enum

Index

Properties

description? filter? transform?

Properties

`Optional`description

description?: string

Optional human-readable schema description.

`Optional`filter

filter?: (value: EnumValueTyped<T>, name: string) => boolean

Optionally excludes native Enum values from the schema.

`Optional`transform

transform?: (name: string, value: EnumValueTyped<T>) => SchemaEnumRepresentation

Optionally transforms native Enum names and values into their schema representation.