Class TransformedProperty<T, S, H, U>

constructor

• new TransformedProperty<
      T extends {},
      S extends DynamicPropertyValue = never,
      H extends DynamicPropertyHolder = DynamicPropertyHolder,
      U extends boolean = false,
  >(
      id: string,
      defaultValue: RequireUndefined<AddUndefined<T, U>>,
      toStored: (value: T) => S,
      fromStored: (value: S) => T,
      hidden?: boolean,
  ): TransformedProperty<T, S, H, U>

  Type Parameters

  • T extends {}
  • S extends DynamicPropertyValue = never
  • H extends DynamicPropertyHolder = DynamicPropertyHolder
  • U extends boolean = false

  Parameters

  • id: string
  • defaultValue: RequireUndefined<AddUndefined<T, U>>
  • toStored: (value: T) => S
  • fromStored: (value: S) => T
  • hidden: boolean = false

  Returns TransformedProperty<T, S, H, U>

Readonlyid

ReadonlydefaultValue

Readonlyhidden

get

• get(holder: H): AddUndefined<T, U>

  Parameters

  • holder: H

  Returns AddUndefined<T, U>

set

• set(holder: H, value: T | undefined): void

  Parameters

  • holder: H
  • value: T | undefined

  Returns void

peek

• peek(holder: H): T | undefined

  Parameters

  • holder: H

  Returns T | undefined

getRaw

• getRaw(holder: H): S | undefined

  Parameters

  • holder: H

  Returns S | undefined

StaticJSON

• JSON<T extends {}, H extends DynamicPropertyHolder, U extends boolean = false>(
      id: string,
      defaultValue: RequireUndefined<AddUndefined<T, U>>,
      hide?: boolean,
  ): TransformedProperty<T, string, H, U>

  Type Parameters

  • T extends {}
  • H extends DynamicPropertyHolder
  • U extends boolean = false

  Parameters

  • id: string
  • defaultValue: RequireUndefined<AddUndefined<T, U>>
  • hide: boolean = false

  Returns TransformedProperty<T, string, H, U>

StaticBinary

• Binary<T extends {}, H extends DynamicPropertyHolder, U extends boolean = false>(
      id: string,
      defaultValue: RequireUndefined<AddUndefined<T, U>>,
      serializer: Serializable<NoInfer<T>>,
      hide?: boolean,
  ): TransformedProperty<T, string, H, U>

  Type Parameters

  • T extends {}
  • H extends DynamicPropertyHolder
  • U extends boolean = false

  Parameters

  • id: string
  • defaultValue: RequireUndefined<AddUndefined<T, U>>
  • serializer: Serializable<NoInfer<T>>
  • hide: boolean = false

  Returns TransformedProperty<T, string, H, U>