Overlay

Callable

• Overlay<T>(packageName: string, overlayName: string, schema: Constructable<OverlaySchema<T>>): (constructor: any) => void

---

• An @Overlay is a class decorator and must be placed on top of a class representing an overlay.

  • An overlay must also extend the AOverlay class.
  • For type safety, the type of overlay being decorated is passed to the decorator.

  @example

  @Overlay<MyOverlay>('@example', 'my-name', MyOverlaySchema)
  export class MyOverlay extends AOverlay<MyOverlaySchema, MyOverlay> { ... }

  @group

  Decorators

  @see

  Definition of Overlays.

  ---

  Type parameters

  • T: UnknownOverlay

  Parameters

  • packageName: string

    The name of the package under which the overlay is registered. Selecting a unique package name helps avoid collisions between same overlay class names across different libraries. You will reuse the same package name throughout your library for different Octo components you create.

  • overlayName: string

    a string that uniquely represents the name of the overlay.

  • schema: Constructable<OverlaySchema<T>>

    The schema of the overlay.

  Returns (constructor: any) => void

  The decorated class.

  • • (constructor: any): void

    • Parameters

      • constructor: any

      Returns void