---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/orchestration/encoding/classes/ParamRef.md
description: >-
  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.
---

# Class: ParamRef

Defined in: [src/batteries/orchestration/encoding.ts:107](https://github.com/NHTIO/ADK/blob/v1.20260906.0/src/src/batteries/orchestration/encoding.ts#L107)

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

```ts
new ParamRef(path: string): ParamRef;
```

Defined in: [src/batteries/orchestration/encoding.ts:116](https://github.com/NHTIO/ADK/blob/v1.20260906.0/src/src/batteries/orchestration/encoding.ts#L116)

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](https://github.com/NHTIO/ADK/blob/v1.20260906.0/src/src/batteries/orchestration/encoding.ts#L109) |

## Methods

### \[ENCODE\_METHOD]\()

```ts
ENCODE_METHOD: Record<string, unknown>;
```

Defined in: [src/batteries/orchestration/encoding.ts:126](https://github.com/NHTIO/ADK/blob/v1.20260906.0/src/src/batteries/orchestration/encoding.ts#L126)

Emit a plain snapshot of the fields for the encoder.

#### Returns

[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`>

***

### \[DECODE\_METHOD]\()

```ts
static DECODE_METHOD: ParamRef;
```

Defined in: [src/batteries/orchestration/encoding.ts:131](https://github.com/NHTIO/ADK/blob/v1.20260906.0/src/src/batteries/orchestration/encoding.ts#L131)

Rebuild an instance from a ParamRef.\[ENCODE\_METHOD] snapshot.

#### Parameters

| Parameter | Type      |
| --------- | --------- |
| `data`    | `unknown` |

#### Returns

`ParamRef`

***

### isParamRef()

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

Defined in: [src/batteries/orchestration/encoding.ts:121](https://github.com/NHTIO/ADK/blob/v1.20260906.0/src/src/batteries/orchestration/encoding.ts#L121)

`instanceof` guard — a look-alike record cannot pass.

#### Parameters

| Parameter | Type      |
| --------- | --------- |
| `v`       | `unknown` |

#### Returns

`v is ParamRef`