# `BootOptions`

> 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 { BootOptions } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 4. Boot

What [`boot`](boot.md) takes. Load one configurator runtime module per page, and boot every product on the
page from it: a 1.x embed (`core.js`) and a 2.0 session, or two 2.0 runtimes loaded from
different URLs (a canary pin and a stable one), cannot share a document, since the first to
load defines `<holo-configurator-viewer>` and the second can never start a viewer. Its [`boot`](boot.md)
rejects HoloBootError 'other' whose `message` names that conflict; a retry never helps. Put a
product another runtime must show in an iframe of its own.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="el"></a>[`el`](BootOptions.el.md) | property | The host element. |
| <a id="accountid"></a>[`accountId`](BootOptions.accountId.md) | property | Your Holostep account id. |
| <a id="configuratorid"></a>[`configuratorId?`](BootOptions.configuratorId.md) | property | The configurator document `_id`. |
| <a id="contract"></a>[`contract`](BootOptions.contract.md) | property | The contract your app was written against. |
| <a id="document"></a>[`document?`](BootOptions.document.md) | property | Page layer of the viewer document (not the configurator): your app's own settings, merged over the platform defaults and under the account's defaults and the configurator's stored document, which win. |
| <a id="signal"></a>[`signal?`](BootOptions.signal.md) | property | Aborting destroys the session. |

## Declaration

```ts
export interface BootOptions {
  el: HTMLElement;
  accountId: number;
  configuratorId?: string;
  contract: '2.0';
  document?: ViewerDocumentJson;
  signal?: AbortSignal;
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `BootOptions` 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: 28 apps (fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4f16d2f6da, app-4fd23bc869, app-510d750508 and 20 more) |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |
