FieldSchemaMetadata Interface
Metadata associated with a FieldSchema.
Signature
/** @sealed */
export interface FieldSchemaMetadata<TCustomMetadata = unknown>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TCustomMetadata | unknown |
Remarks
Specified via metadata.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| custom | optional, readonly |
TCustomMetadata | User-defined metadata. |
| description | optional, readonly |
string | undefined | The description of the field. |
Property Details
custom
User-defined metadata.
Signature
readonly custom?: TCustomMetadata;
Type: TCustomMetadata
description
The description of the field.
Signature
readonly description?: string | undefined;
Type: string | undefined
Remarks
If provided, will be used by the system in scenarios where a description of the field is useful. E.g., when converting a field schema to JSON Schema, this description will be used as the description field.