aran/lib/weave/flexible/config.d.ts

JavaScript instrumenter

import type { Pointcut } from "./aspect.d.ts";
import type { GetDefault, Json } from "../../util/util.d.ts";
import type { Atom } from "../../lang/syntax.d.ts";

/**
 * Configuration object for both flexible weaving.
 */
export type Config<
  param extends Partial<Atom> & {
    Point?: Json[];
    InitialState?: Json;
    AdviceGlobalVariable?: string;
  } = {},
> = {
  /**
   * The initial state passed to advice functions. It will be cloned with JSON.
   * @defaultValue `null`
   */
  initial_state: GetDefault<param, "InitialState", Json>;
  /**
   * The pointcut for the standard weaving API.
   * @defaultValue `false`
   */
  pointcut: Pointcut<param>;
};