Skip to main content

@idpass/data-collect-core / AdapterFieldDefinition

Interface: AdapterFieldDefinition

Defined in: interfaces/adapter-configs.ts:24

Field definition for adapter configuration. Defines the schema for a single configuration field that an adapter requires.

Properties​

name​

name: string

Defined in: interfaces/adapter-configs.ts:26

Internal field name used in config storage

label​

label: string

Defined in: interfaces/adapter-configs.ts:28

Human-readable label for the field

type​

type: "number" | "select" | "text" | "password" | "url"

Defined in: interfaces/adapter-configs.ts:30

Input type for rendering the field in the UI

required​

required: boolean

Defined in: interfaces/adapter-configs.ts:32

Whether the field is required for the adapter to function

placeholder?​

optional placeholder: string

Defined in: interfaces/adapter-configs.ts:34

Placeholder text shown in the input

helpText?​

optional helpText: string

Defined in: interfaces/adapter-configs.ts:36

Help text displayed below the input

options?​

optional options: object[]

Defined in: interfaces/adapter-configs.ts:38

Options for select type fields

value​

value: string

label​

label: string

default?​

optional default: string | number

Defined in: interfaces/adapter-configs.ts:40

Default value for the field