# `IMagneticPlaneRule`

> 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 { IMagneticPlaneRule } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 21. Stored data (vendored; replaces @holo/interfaces)

A stored rule that gives a GroupNode's child models plane configs by mesh-name pattern.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="meshnamepattern"></a>[`meshNamePattern`](IMagneticPlaneRule.meshNamePattern.md) | property | Which planes it applies to, matched against each plane node's cleaned name (spec section 6.9, ID1). |
| <a id="connector"></a>[`connector?`](IMagneticPlaneRule.connector.md) | property | As [`IMagneticPlaneConfig.connector`](IMagneticPlaneConfig.connector.md). |
| <a id="allowedtypes"></a>[`allowedTypes?`](IMagneticPlaneRule.allowedTypes.md) | property | As [`IMagneticPlaneConfig.allowedTypes`](IMagneticPlaneConfig.allowedTypes.md). |
| <a id="priority"></a>[`priority?`](IMagneticPlaneRule.priority.md) | property |  |
| <a id="enabled"></a>[`enabled?`](IMagneticPlaneRule.enabled.md) | property |  |

## Declaration

```ts
export interface IMagneticPlaneRule {
  meshNamePattern: string;
  connector?: string;
  allowedTypes?: string[] | string;
  priority?: number;
  enabled?: boolean;
  [key: string]: string | number | boolean | string[] | undefined;
}
```

## Generic-API test (spec 3.1)

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