CompletionField

@webda/ql

---

Interface: CompletionField

Defined in: packages/ql/src/completion.ts:15

Field metadata used to provide field completions and contextual value suggestions

Properties

description?

optional description?: string

Defined in: packages/ql/src/completion.ts:23

Field description

---

enum?

optional enum?: (string | number | boolean)[]

Defined in: packages/ql/src/completion.ts:21

Enum values from the schema

---

name

name: string

Defined in: packages/ql/src/completion.ts:17

Dotted path, e.g. "profile.email"

---

type?

optional type?: "string" | "number" | "boolean" | "object" | "integer" | "array"

Defined in: packages/ql/src/completion.ts:19

JSON schema type, used for value candidates