AxFluentFieldType

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/sig.ts#L143

Type Parameters

Type Parameter	Default type
`TType` extends `AxFieldType`[`"type"`]	`AxFieldType`[`"type"`]
`TIsArray` extends `boolean`	`false`
`TOptions` extends readonly `string`[] \| `undefined`	`undefined`
`TIsOptional` extends `boolean`	`false`
`TIsInternal` extends `boolean`	`false`

Implements

AxFieldType

Constructors

Constructor

new AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, TIsInternal>(fieldType: object): AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, TIsInternal>;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/sig.ts#L158

Parameters

Parameter	Type
`fieldType`	{ `description?`: `string`; `isArray`: `TIsArray`; `isInternal`: `TIsInternal`; `isOptional`: `TIsOptional`; `options?`: `TOptions`; `type`: `TType`; }
`fieldType.description?`	`string`
`fieldType.isArray`	`TIsArray`
`fieldType.isInternal`	`TIsInternal`
`fieldType.isOptional`	`TIsOptional`
`fieldType.options?`	`TOptions`
`fieldType.type`	`TType`

Returns

AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, TIsInternal>

Properties

Property	Modifier	Type
`description?`	`readonly`	`string`
`isArray`	`readonly`	`TIsArray`
`isInternal`	`readonly`	`TIsInternal`
`isOptional`	`readonly`	`TIsOptional`
`options?`	`readonly`	`TOptions`
`type`	`readonly`	`TType`

Methods

array()

array(): AxFluentFieldType<TType, true, TOptions, TIsOptional, TIsInternal>;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/sig.ts#L181

Returns

AxFluentFieldType<TType, true, TOptions, TIsOptional, TIsInternal>

internal()

internal(): AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, true>;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/sig.ts#L188

Returns

AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, true>

optional()

optional(): AxFluentFieldType<TType, TIsArray, TOptions, true, TIsInternal>;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/sig.ts#L174

Returns

AxFluentFieldType<TType, TIsArray, TOptions, true, TIsInternal>