AxFluentFieldInfo Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxFluentFieldInfo.md interface AxFluentFieldInfo

AxFluentFieldInfo

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L1481

Type Parameters

Type Parameter	Default type
`TType` extends `AxFieldType`[`"type"`]	`AxFieldType`[`"type"`]
`TIsArray` extends `boolean`	`false`
`TOptions` extends readonly `string`[]	readonly `string`[]
`TIsOptional` extends `boolean`	`false`
`_TIsInternal` extends `boolean`	`false`
`TFields` extends \| `Record`<`string`, `AxFluentFieldInfo` \| `AxFluentFieldType`> \| `undefined`	`undefined`
`_TIsCached` extends `boolean`	`false`

Properties

Property	Modifier	Type
`description?`	`readonly`	`string`
`fields?`	`readonly`	`TFields`
`format?`	`readonly`	`string`
`isArray?`	`readonly`	`TIsArray`
`isCached?`	`readonly`	`boolean`
`isInternal?`	`readonly`	`boolean`
`isOptional?`	`readonly`	`TIsOptional`
`itemDescription?`	`readonly`	`string`
`maximum?`	`readonly`	`number`
`maxLength?`	`readonly`	`number`
`minimum?`	`readonly`	`number`
`minLength?`	`readonly`	`number`
`options?`	`readonly`	`TOptions`
`pattern?`	`readonly`	`string`
`patternDescription?`	`readonly`	`string`
`type`	`readonly`	`TType`

Docs