• Preparing search index...
  • The search index is not available
Roqueform
  • Roqueform
  • annotations-plugin
  • annotationsPlugin

Function annotationsPlugin

  • annotationsPlugin(): PluginInjector<AnnotationsPlugin<ReadonlyDict>>
  • Enhances fields with methods that manage annotations.

    Returns PluginInjector<AnnotationsPlugin<ReadonlyDict>>

  • annotationsPlugin<Annotations>(annotations, applyPatch?): PluginInjector<AnnotationsPlugin<Annotations>>
  • Enhances fields with methods that manage annotations.

    Type Parameters

    • Annotations extends object

      Annotations associated with fields.

    Parameters

    • annotations: Annotations

      The initial annotations that are associated with fields.

    • OptionalapplyPatch: ((annotations: Readonly<Annotations>, patch: Readonly<Partial<Annotations>>) => Annotations)

      The callback that applies patches to field annotations. By default, patches are applied using Object.assign.

        • (annotations, patch): Annotations
        • Parameters

          • annotations: Readonly<Annotations>
          • patch: Readonly<Partial<Annotations>>

          Returns Annotations

    Returns PluginInjector<AnnotationsPlugin<Annotations>>

Settings

Member Visibility
Roqueform
  • Loading...