Class MappingHelper<FROM, TO>

constructor

• new MappingHelper<FROM, TO>(
      mappingInfo: { [key in string | number | symbol]: keyof TO } | undefined,
  ): MappingHelper<FROM, TO>

  Type Parameters

  • FROM
  • TO

  Parameters

  • mappingInfo: { [key in string | number | symbol]: keyof TO } | undefined

    Optional mapping definition from FROM keys to TO keys

  Returns MappingHelper<FROM, TO>

mapFromTo

mapToFrom

addFromToMapping

• addFromToMapping(fromName: keyof FROM, toName: keyof TO): void

  Adds a mapping from a FROM property to a TO property

  Parameters

  • fromName: keyof FROM

    The FROM-side property name

  • toName: keyof TO

    The TO-side property name

  Returns void

addToFromMapping

• addToFromMapping(toName: keyof TO, fromName: keyof FROM): void

  Adds a mapping from a TO property to a FROM property

  Parameters

  • toName: keyof TO

    The TO-side property name

  • fromName: keyof FROM

    The FROM-side property name

  Returns void

from

• from(
      value: TO | null | undefined,
      oldFrom?: FROM | null,
  ): FROM | null | undefined

  Maps a TO value back to its FROM representation

  Parameters

  • value: TO | null | undefined

    The TO value to map from

  • OptionaloldFrom: FROM | null

    Optional existing FROM value to extend

  Returns FROM | null | undefined

  The mapped FROM value

getValueAs

• getValueAs(toName: keyof TO, parent: FROM): any

  Gets a value from the FROM object using the TO property name

  Parameters

  • toName: keyof TO

    The TO-side property name

  • parent: FROM

    The FROM object to read from

  Returns any

  The mapped value

setValueAs

• setValueAs(toName: keyof TO, parent: FROM, value: any): void

  Sets a value on the FROM object using the TO property name

  Parameters

  • toName: keyof TO

    The TO-side property name

  • parent: FROM

    The FROM object to modify

  • value: any

    The value to set

  Returns void

to

• to(value: FROM | null | undefined, oldTo?: TO | null): TO | null | undefined

  Maps a FROM value to its TO representation

  Parameters

  • value: FROM | null | undefined

    The FROM value to map

  • OptionaloldTo: TO | null

    Optional existing TO value to extend

  Returns TO | null | undefined

  The mapped TO value