Class: ParamRef

Defined in: src/batteries/orchestration/encoding.ts:107

A hole in a template's staged values, substituted at instantiation. A CLASS for the same reason NodeRef is: a look-alike record must not be mistaken for a hole.

Constructors

Constructor

new ParamRef(path: string): ParamRef;

Defined in: src/batteries/orchestration/encoding.ts:116

Construct a ParamRef.

Parameters

Parameter	Type	Description
path	string	The declared template params entry this hole names.

Returns

ParamRef

Properties

Property	Type	Description	Defined in
path	string	Must name a declared template params entry (checked at construction).	src/batteries/orchestration/encoding.ts:109

Methods

[ENCODE_METHOD]()

ENCODE_METHOD: Record<string, unknown>;

Defined in: src/batteries/orchestration/encoding.ts:126

Emit a plain snapshot of the fields for the encoder.

Returns

Record<string, unknown>

---

[DECODE_METHOD]()

static DECODE_METHOD: ParamRef;

Defined in: src/batteries/orchestration/encoding.ts:131

Rebuild an instance from a ParamRef.[ENCODE_METHOD] snapshot.

Parameters

Parameter	Type
data	unknown

Returns

ParamRef

---

isParamRef()

static isParamRef(v: unknown): v is ParamRef;

Defined in: src/batteries/orchestration/encoding.ts:121

instanceof guard — a look-alike record cannot pass.

Parameters

Parameter	Type
v	unknown

Returns

v is ParamRef