Function BooleanAttribute

  • BooleanAttribute<T, K, P>(props?): ((_value, context) => void)

  • A decorator for marking class fields as boolean attributes within the context of a single-table design entity

    Can be set to nullable via decorator props

    Type Parameters

    • T extends default

      The class type that the decorator is applied to, ensuring type safety and integration within specific class instances.

    • K extends boolean

      A type constraint extending boolean, ensuring that the decorator is only applied to class fields specifically intended to represent booleans.

    • P extends AttributeOptions

    Parameters

    • Optional props: P

      An AttributeOptions object providing configuration options for the attribute, such as its alias which allows the attribute to be referred to by an alternative name in the database context. The nullable property is also set to false by default.

    Returns ((_value, context) => void)

    A class field decorator function that operates within the class field's context. It configures the field as a boolean attribute and defines how it should be serialized and deserialized to/from DynamoDB.

    Usage example:

    class MyEntity extends MyTable {
      @BooleanAttribute({ alias: 'MyField' })
      public myField: boolean;

      @BooleanAttribute({ alias: 'MyNullableField', nullable: true })
      public myField?: boolean; // Set to Optional
    }

    Here, @BooleanAttribute decorates myField of MyEntity, marking it as an entity attribute with an alias 'MyField' for ORM purposes.

Settings

Member Visibility

Theme

Generated using TypeDoc