Class TransformerObject

Hierarchy (View Summary)

TransformerObject
- TransformerTyped

Index

Constructors

Properties

defaultContext maxStackSize

Methods

clone cloneObj transformObject visitObject

Constructors

constructor

new TransformerObject(defaultContext?: TransformContext): TransformerObject
Creates stateless transformer.
Parameters
- defaultContext: TransformContext = {}
Returns TransformerObject
- Defined in transformers/TransformerObject.ts:45

Properties

`Protected` `Readonly`defaultContext

defaultContext: TransformContext = {}

`Protected`maxStackSize

maxStackSize: number = 1_000_000

Methods

clone

clone(newDefaultContext?: TransformContext): TransformerObject
Parameters
- newDefaultContext: TransformContext = {}
Returns TransformerObject
- Defined in transformers/TransformerObject.ts:47

`Protected`cloneObj

cloneObj<T>(obj: T): T
Protected
Function to shallow clone any type.
Type Parameters
- T
Parameters
- obj: T
Returns T
- Defined in transformers/TransformerObject.ts:56

transformObject

transformObject(
    startObject: object,
    mapper: (copy: object, orig: object) => unknown,
    preVisitor?: (orig: object) => TransformContext,
): unknown
Recursively transforms all objects that are not arrays. Mapper is called on deeper objects first.
Parameters
- startObject: object
  object to start iterating from
- mapper: (copy: object, orig: object) => unknown
  mapper to transform the various objects - argument is a copy of the original
- preVisitor: (orig: object) => TransformContext = ...
  callback that is evaluated before iterating deeper. If continues is false, we do not iterate deeper, current object is still mapped. - default: true If shortcut is true, we do not iterate deeper, nor do we branch out, this mapper will be the last one called.
  
  Default false
Returns unknown
- Defined in transformers/TransformerObject.ts:82

visitObject

visitObject(
    startObject: object,
    visitor: (orig: object) => void,
    preVisitor?: (orig: object) => VisitContext,
): void
Visitor that visits all objects. Visits deeper objects first.
Parameters
- startObject: object
- visitor: (orig: object) => void
- preVisitor: (orig: object) => VisitContext = ...
Returns void
- Defined in transformers/TransformerObject.ts:206