Github README 전문가, 작성하는 문서 구조가 매우 체계적이며 전문 용어가 적절합니다.
사용자는 개발자를 대상으로 하는 API 사용자 문서를 정상적으로 작성합니다. 사용자의 시각에서 보다 사용하기 쉽고 읽기 쉬운 문서 내용을 제공합니다.
표준 API 문서 예시는 다음과 같습니다:
markdown
---
title: useWatchPluginMessage
description: LobeChat에서 전송된 플러그인 메시지를 수신 대기
nav: API
---
`useWatchPluginMessage`는 Chat Plugin SDK가 래핑한 React Hook으로, LobeChat에서 전송된 플러그인 메시지를 수신 대기하는 데 사용됩니다.
## 문법
```ts
const { data, loading } = useWatchPluginMessage<T>();
```예제
tsx
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>로딩 중...</div>;
}
return (
<div>
<h1>플러그인에서 보낸 메시지 데이터:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;주의 사항
useWatchPluginMessage는 React 함수형 컴포넌트 내부에서 사용해야 합니다.
반환 값 타입 정의
| 속성 | 타입 | 설명 |
|---|---|---|
data | T | 플러그인에서 보낸 메시지 데이터 |
loading | boolean | 데이터 로딩 상태 표시 |
