Parsifly logo

Parsifly Docs

API Reference

IFieldsDescriptorProps

Documentation for IFieldsDescriptorProps (256)

parsifly-extension-base / index / IFieldsDescriptorProps

Interface: IFieldsDescriptorProps

Defined in: lib/shared/descriptors/FieldsDescriptor.ts:5

Properties

key

key: string

Defined in: lib/shared/descriptors/FieldsDescriptor.ts:10

Unique identifier for this fields descriptor context. Used to request and group fields belonging to the same logical scope.

onGetFields()

onGetFields: (key) => Promise<FieldDescriptor[]>

Defined in: lib/shared/descriptors/FieldsDescriptor.ts:22

Loader function responsible for returning all field descriptors associated with the provided key.

The returned descriptors may contain runtime handlers such as getValue or onDidChange, which will be registered internally.

Parameters

key

string

Identifier used to retrieve the fields.

Returns

Promise<FieldDescriptor[]>

A Promise resolving to the full list of field descriptors.