Skip to main content

Anchor

Callable

  • Anchor(packageName: string): (constructor: any) => void

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

    • An anchor must also extend the AAnchor class.
    @example
    @Anchor('@example')
    export class MyAnchor extends AAnchor<MyAnchorSchema, MyModel> { ... }
    @group

    Decorators

    @see

    Definition of Anchors.


    Parameters

    • packageName: string

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

    Returns (constructor: any) => void

    The decorated class.

      • (constructor: any): void
      • Parameters

        • constructor: any

        Returns void