Interface AnnotationsMixin<Annotations>

The mixin added to fields by the annotationsPlugin.

interface AnnotationsMixin<Annotations extends object> {
    annotations: Annotations;
    annotate(
        patch: Partial<Annotations> | ((field: never) => Partial<Annotations>),
        options?: AnnotateOptions,
    ): void;
}

Type Parameters

Annotations extends object
Annotations associated with fields.

Index

Properties

Methods

Properties

annotations

annotations: Annotations

Annotations associated with this field.

Methods

annotate

annotate(
patch: Partial<Annotations> | ((field: never) => Partial<Annotations>),
options?: AnnotateOptions,
): void
Updates annotations of this field.
Parameters
- patch: Partial<Annotations> | ((field: never) => Partial<Annotations>)
  The patch that is applied to current annotations, or a callback that receives the current annotations and returns a patch that must be applied.
- Optionaloptions: AnnotateOptions
  Additional options.
Returns void