ObjectMapper.prototype.map - Lynx Mapper documentation



ObjectMapper.prototype.map(input: TInput,
context: OptionalArgIfUndefined<TContext>,
): TOutput

Maps an input object to an output object.

It does so by iterating each property in the object schema, and invoking the property's mapping function, passing the input and context.

Parameters



input: TInput



context: OptionalArgIfUndefined<TContext>

TOutput



ObjectMapper.prototype.map(input: TInput | null,
context: OptionalArgIfUndefined<TContext>,
): TOutput | null

Maps an input object to an output object.

It does so by iterating each property in the object schema, and invoking the property's mapping function, passing the input and context.

If input is null, it will be returned as-is.



input: TInput | null



context: OptionalArgIfUndefined<TContext>

TOutput | null



ObjectMapper.prototype.map(input: TInput | undefined,
context: OptionalArgIfUndefined<TContext>,
): TOutput | undefined

Maps an input object to an output object.

It does so by iterating each property in the object schema, and invoking the property's mapping function, passing the input and context.

If input is undefined, it will be returned as-is.



input: TInput | undefined



context: OptionalArgIfUndefined<TContext>

TOutput | undefined



ObjectMapper.prototype.map(input: TInput
 | null
 | undefined,
context: OptionalArgIfUndefined<TContext>,
): TOutput
 | null
 | undefined

Maps an input object to an output object.

It does so by iterating each property in the object schema, and invoking the property's mapping function, passing the input and context.

If input is null or undefined, it will be returned as-is.



input: TInput
 | null
 | undefined



context: OptionalArgIfUndefined<TContext>

TOutput
 | null
 | undefined