@wpkernel/php-json-ast v0.12.6-beta.3

---

@wpkernel/php-json-ast / CreateHelperOptions

Interface: CreateHelperOptions<TContext, TInput, TOutput, TReporter, TKind>

Input accepted by createHelper.

Remarks

Omitted metadata is normalised to mode: 'extend', priority: 0, and an empty dependency list. The dependency list is copied and frozen.

Type Parameters

TContext

TContext

Per-run context type.

TInput

TInput

Phase-specific input type.

TOutput

TOutput

Value transformed by the helper chain.

TReporter

TReporter extends PipelineReporter = PipelineReporter

Reporter type available during execution.

TKind

TKind extends HelperKind = HelperKind

Literal helper kind represented by the descriptor.

Properties

apply

readonly apply: HelperApplyFn<TContext, TInput, TOutput, TReporter>;

Helper implementation.

---

key

readonly key: string;

Dependency and override identity within the helper kind.

---

kind

readonly kind: TKind;

Pipeline phase in which the helper executes.

---

dependsOn?

readonly optional dependsOn: readonly string[];

Prerequisite helper keys.

Default Value

[]

---

mode?

readonly optional mode: HelperMode;

Duplicate-key policy.

Default Value

'extend'

---

origin?

readonly optional origin: string;

Optional provenance label used in diagnostics.

---

priority?

readonly optional priority: number;

Relative ordering hint.

Default Value

0