CollectionOptions.role ​

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.

Property of CollectionOptions · stable · since 2.0.0

ts
role?: Role;

Applies at creation only; on a live name, an omitted role is no check and a different one throws 'collection-role-mismatch'.

Default: 'product' (a new collection)

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: role 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)