# `FollowOptions`

> 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 { FollowOptions } from '@holostep-configurators/runtime-client/contract';` · stable · since 2.0.0 · section 6. Queries, rules and parts

What `follow` takes. The follower takes its target's whole pose.

## Members

| Member | Kind | Summary |
| --- | --- | --- |
| <a id="offset"></a>[`offset?`](FollowOptions.offset.md) | property | 'rest': keep the offset the two parts have in their rest poses (safe to call any time). |
| <a id="signal"></a>[`signal?`](FollowOptions.signal.md) | property | Aborting stops following; already aborted, none starts ([`SignalOption`](SignalOption.md)). |

## Declaration

```ts
export interface FollowOptions {
  offset?: 'rest' | 'current' | 'none';
  signal?: AbortSignal;
}
```

## Generic-API test (spec 3.1)

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