getTreeWalkerRequestTransformer

function getTreeWalkerRequestTransformer<TState>(
    visitors,
    initialState,
): RpcRequestTransformer;

Creates a transformer that traverses the request parameters and executes the provided visitors at each node. A custom initial state can be provided but must at least provide { keyPath: [] }.

Type Parameters

Type Parameter
TState extends Readonly<{ keyPath: KeyPath; }>

Parameters

ParameterType
visitorsNodeVisitor[]
initialStateTState

Returns

RpcRequestTransformer

Example

import { getTreeWalkerRequestTransformer } from '@solana/rpc-transformers';
 
const requestTransformer = getTreeWalkerRequestTransformer(
    [
        // Replaces foo.bar with "baz".
        (node, state) => (state.keyPath === ['foo', 'bar'] ? 'baz' : node),
        // Increments all numbers by 1.
        node => (typeof node === number ? node + 1 : node),
    ],
    { keyPath: [] },
);

On this page