# `Problem`

> Contract 2.0.0 · package sha256 `a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e` · generated from `configurator-runtime.d.ts` by `services/onsite-scripter/scripts/build-contract-docs.mjs`; edit the source, not this file.

Interface · `import type { Problem } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 2. Operations, reports, causes, problems

Data, never an Error: safe to store, send and render. Frozen.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="code"></a>[`code`](Problem.code.md) | property | What happened; see [`ProblemCode`](ProblemCode.md). |
| <a id="message"></a>[`message`](Problem.message.md) | property | At most 200 characters. |
| <a id="docs"></a>[`docs`](Problem.docs.md) | property | URL of this code's page for this contract version. |
| <a id="op"></a>[`op?`](Problem.op.md) | property | The operation it belongs to, when one does. |
| <a id="path"></a>[`path?`](Problem.path.md) | property | JSON path or member path the problem is about. |
| <a id="node"></a>[`node?`](Problem.node.md) | property | The scene-model node it belongs to; unset for a collection item's or a stage layer's (see `path`). |
| <a id="url"></a>[`url?`](Problem.url.md) | property | The failed asset, without query string or fragment. |
| <a id="asset"></a>[`asset?`](Problem.asset.md) | property | For 'asset-failed' and 'asset-degraded': what failed. |
| <a id="event"></a>[`event?`](Problem.event.md) | property | The event name, for 'handler-threw', 'handler-async', 'handler-rejected' and 'unknown-event'. |
| <a id="layer"></a>[`layer?`](Problem.layer.md) | property | The document layer, for 'document-error' and 'apply-failed' (see `info().document.layers`). |
| <a id="didyoumean"></a>[`didYouMean?`](Problem.didYouMean.md) | property | Up to 3 close matches, e.g. authored names for 'target-unmatched'; for 'invalid-input', the thrown HoloInputError's `didYouMean` (spec section 8.1). |
| <a id="at"></a>[`at`](Problem.at.md) | property | Epoch milliseconds. |

## Declaration

```ts
export interface Problem {
  readonly code: ProblemCode;
  readonly message: string;
  readonly docs: string;
  readonly op?: OpId;
  readonly path?: string;
  readonly node?: string;
  readonly url?: string;
  readonly asset?: 'model' | 'texture' | 'environment' | 'other';
  readonly event?: string;
  readonly layer?: string;
  readonly didYouMean?: readonly string[];
  readonly at: number;
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `Problem` names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | pass: 20 apps (fleet cross-check: app-04c2774145, app-37356bf09f, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-822bb9d6aa, app-8675b3225c, app-b362a81c85 and 12 more) |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |