# SyGridAlignedGridsResult

Fields, allowed values, and APIs that use SyGridAlignedGridsResult.

Canonical: https://grid.syidax.com/docs/types/SyGridAlignedGridsResult/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface SyGridAlignedGridsResult {
  readonly status: 'joined' | 'left' | 'unchanged' | 'refused';
  readonly group: string | null;
  readonly reason: SyGridAlignedGridsRefusalReason | null;
  readonly detail: string | null;
  readonly seeded: boolean;
  readonly members: ReadonlyArray<string>;
  readonly mismatches: ReadonlyArray<SyGridAlignedMismatch>;
  readonly peersConfigured: number;
}
```

<a id="used-by"></a>

## APIs using this type

- [setAlignedGrids](https://grid.syidax.com/docs/methods/setAlignedGrids.md) — Configures aligned Grid connections and returns the result.

<a id="parents"></a>

## Contracts containing this type

- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)

<a id="related"></a>

## Related types

- [SyGridAlignedGridsRefusalReason](https://grid.syidax.com/docs/types/SyGridAlignedGridsRefusalReason.md)
- [SyGridAlignedMismatch](https://grid.syidax.com/docs/types/SyGridAlignedMismatch.md)