# `CollectionOptions`

> 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 { CollectionOptions } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 7. Collections and shapes

What [`collection(name, options)`](Writer.collection.md) takes. All apply at creation.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="role"></a>[`role?`](CollectionOptions.role.md) | property | Applies at creation only; on a live name, an omitted role is no check and a different one throws 'collection-role-mismatch'. |
| <a id="attachto"></a>[`attachTo?`](CollectionOptions.attachTo.md) | property | Follow this part: re-attached after reloads. |
| <a id="signal"></a>[`signal?`](CollectionOptions.signal.md) | property | Aborting disposes the collection; already aborted, the new collection is born disposed ([`SignalOption`](SignalOption.md)). |

## Declaration

```ts
export interface CollectionOptions {
  role?: Role;
  attachTo?: Query;
  signal?: AbortSignal;
}
```

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `CollectionOptions` names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |