# getSyncStatus

현재 협업 연결·동기화 상태를 읽습니다.

Canonical: https://grid.syidax.com/ko/docs/methods/getSyncStatus/

<a id="meaning"></a>

## 무엇을 하는 API인가요

현재 협업 연결·동기화 상태를 읽습니다.

Pro 기능 관련 API: Real-time collaboration (existing Pro grade retained)

<a id="contract"></a>

## 입력과 결과의 정확한 타입

```typescript
getSyncStatus(): Promise<GridSyncStatus>
```

| 인수 | 필수 여부 | 타입 |
| --- | --- | --- |

반환 타입은 `Promise<GridSyncStatus>`입니다.

<a id="usage"></a>

## 사용 흐름

등록과 초기화를 마친 Grid 요소에서 grid.getSyncStatus(…)를 호출합니다. 반환값은 await로 읽으세요. boolean이나 보고서를 반환하는 메서드는 결과를 확인한 뒤 다음 작업을 진행합니다.

<a id="types"></a>

## 관련 타입 읽기

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

<a id="recipes"></a>

## 기능별 설명과 예제

- [실시간 협업](https://grid.syidax.com/ko/docs/features/collaboration.md) — 협업은 같은 방에 참여한 사용자 사이에서 편집·커서·참여 상태를 공유합니다. 방 이름만 지정했다고 다른 기기의 데이터가 인터넷을 통해 자동 연결되는 것은 아닙니다.