parsifly-extension-base / index / TFieldDescriptor

Type Alias: TFieldDescriptor<TValue>

TFieldDescriptor<TValue> = object

Defined in: lib/shared/descriptors/FieldDescriptor.ts:4

Type Parameters

TValue

TValue extends TFieldDescriptorValue = TFieldDescriptorValue

Properties

children?

optional children: boolean

Defined in: lib/shared/descriptors/FieldDescriptor.ts:14

Define if a item can have a children list

defaultValue?

optional defaultValue: string

Defined in: lib/shared/descriptors/FieldDescriptor.ts:17

description?

optional description: string

Defined in: lib/shared/descriptors/FieldDescriptor.ts:16

Details of the record

icon?

optional icon: string

Defined in: lib/shared/descriptors/FieldDescriptor.ts:12

VS Code icons

key

key: string

Defined in: lib/shared/descriptors/FieldDescriptor.ts:6

Identifier

label

label: string

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

Title, main information for the record

name

name: string

Defined in: lib/shared/descriptors/FieldDescriptor.ts:7

type

type: string

Defined in: lib/shared/descriptors/FieldDescriptor.ts:8

Methods

getValue()?

optional getValue(): Promise<TValue>

Defined in: lib/shared/descriptors/FieldDescriptor.ts:19

Returns

Promise<TValue>

onDidChange()?

optional onDidChange(value): Promise<void>

Defined in: lib/shared/descriptors/FieldDescriptor.ts:20

Parameters

value

TValue

Returns

Promise<void>