Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VulcanGraphqlFieldSchemaServer

Hierarchy

Index

Properties

Optional afterComponent

afterComponent: any

Optional allowedValues

allowedValues: any[]

Optional apiOnly

apiOnly: boolean

Optional arrayItem

arrayItem: any

Optional autoValue

autoValue: AutoValueFunction<any>

Optional autocompleteQuery

autocompleteQuery: string | (() => string)

Optional beforeComponent

beforeComponent: any

Optional blackbox

blackbox: boolean

Optional canCreate

canCreate: PermissionDefinition | PermissionDefinition[]

Optional canRead

canRead: PermissionDefinition | PermissionDefinition[]

Optional canUpdate

canUpdate: PermissionDefinition | PermissionDefinition[]

Optional control

control: any

Optional custom

custom: ValidationFunction

Optional decimal

decimal: boolean

Optional defaultValue

defaultValue: any

Optional description

description: string

Optional exclusiveMax

exclusiveMax: boolean

Optional exclusiveMin

exclusiveMin: boolean

Optional form

form: any

Optional group

group: FieldGroup

Optional hidden

hidden: boolean | ((args: { document: any; props: any }) => boolean)

Optional input

input: any

Optional inputProperties

inputProperties: any

Optional intl

intl: boolean

Optional intlId

intlId: string

Optional isIntlData

isIntlData: boolean

Optional itemProperties

itemProperties: any

Optional label

label: string

Optional max

max: number | boolean | Date

Optional maxCount

maxCount: number

Optional min

min: number | boolean | Date

Optional minCount

minCount: number

Optional optional

optional: boolean

Optional options

options: any

Optional order

order: any

Optional orderable

orderable: boolean

Optional placeholder

placeholder: any

Optional query

query: string | (() => string)

Optional regEx

regEx: RegExp | RegExp[]

Optional relation

Optional resolveAs

Optional searchable

searchable: boolean

Optional selectable

selectable: boolean

Optional sortable

sortable: boolean

Optional trim

trim: boolean

type

type: VulcanFieldType

Optional typeName

typeName: string

Optional unique

unique: boolean

Methods

Optional onCreate

  • onCreate(input: OnCreateInput<any>): TField | Promise<TField>
  • Parameters

    • input: OnCreateInput<any>

    Returns TField | Promise<TField>

Optional onDelete

  • onDelete(input: OnDeleteInput<any>): TField | Promise<void>
  • Parameters

    • input: OnDeleteInput<any>

    Returns TField | Promise<void>

Optional onUpdate

  • onUpdate(input: OnUpdateInput<any>): TField | Promise<TField>
  • Parameters

    • input: OnUpdateInput<any>

    Returns TField | Promise<TField>

Generated using TypeDoc