cton-js
    Preparing search index...

    Class TypeRegistry

    Index

    Constructors

    Accessors

    • get registeredTypes(): Constructor[]

      List all registered types

      Returns Constructor[]

      Array of constructors

    Methods

    • Get the handler for a class

      Parameters

      • klass: Constructor

        The class to look up

      Returns Handler | null

      Handler or null

    • Register a custom type handler

      Type Parameters

      • T

      Parameters

      • klass: Constructor

        The class/constructor to handle

      • as: TransformMode = "object"

        How to serialize: 'object', 'array', or 'scalar'

      • transform: (value: T) => unknown

        Transformation function

      Returns void

      registry.register(Money, 'object', (money) => ({
      amount: money.cents,
      currency: money.currency
      }));
      registry.register(UUID, 'scalar', (uuid) => uuid.toString());
      
    • Check if a handler exists for a class

      Parameters

      • klass: Constructor

        The class to check

      Returns boolean

      boolean

    • Transform a value using its registered handler Returns the value unchanged if no handler is registered

      Parameters

      • value: unknown

        The value to transform

      Returns unknown

      The transformed value

    • Unregister a type handler

      Parameters

      • klass: Constructor

        The class/constructor to unregister

      Returns void