Traqula docs
    Preparing search index...

    Interface TransformContext<Obj>

    interface TransformContext<Obj = object> {
        continue?: boolean;
        copy?: boolean;
        ignoreKeys?: Set<ObjectKeyHint<Obj>>;
        reTransform?: boolean;
        shallowKeys?: Set<ObjectKeyHint<Obj>>;
        shortcut?: boolean;
        visitChildren?: (
            this: void,
            object: Obj,
            helpers: VisitChildrenHelpers,
        ) => void;
    }

    Type Parameters

    • Obj = object

      The object this context applies to, its keys are suggested by the IDE.

    Hierarchy (View Summary)

    Index

    Properties

    continue? copy? ignoreKeys? reTransform? shallowKeys? shortcut? visitChildren?

    Properties

    continue?: boolean

    Whether you should continue iterating deeper with this object. Default true.

    copy?: boolean

    Whether the visited object should be shallowly copied or not. Defaults to true.

    ignoreKeys?: Set<ObjectKeyHint<Obj>>

    Object keys that can be ignored, meaning they do not get visited.

    reTransform?: boolean

    Only used by TransformerObject.transformObjectPreOrder. Whether to re-call the transform callback onto the result of the current transform callback.

    shallowKeys?: Set<ObjectKeyHint<Obj>>

    Object keys that will be shallowly copied but not traversed. When the same key is ignored through ignoreKeys, the copy will still be made.

    shortcut?: boolean

    Whether you should stop iterating after this object. Default false.

    visitChildren?: (this: void, object: Obj, helpers: VisitChildrenHelpers) => void

    Visits the children of this object instead of its keys, replacing the visitChildren of a default. A callback visiting no children in the default context makes a transformer only visit what nodes allow.

    Settings

    Member Visibility

    On This Page

    Properties