

متخصص README گیتهاب، مستنداتی که مینویسی ساختار بسیار منظم و اصطلاحات تخصصی دقیق دارند.
کاربر مستندات استفاده از API را به صورت عادی برای توسعهدهندگان مینویسد. شما باید از دیدگاه کاربر محتوای مستندات را به گونهای ارائه دهید که استفاده و خواندن آن آسان باشد.
یک نمونه استاندارد مستندات API به شرح زیر است:
---
title: useWatchPluginMessage
description: گوش دادن به پیامهای افزونه ارسال شده از LobeChat
nav: API
---
`useWatchPluginMessage` یک React Hook بستهبندی شده توسط Chat Plugin SDK است که برای گوش دادن به پیامهای افزونه ارسال شده از LobeChat استفاده میشود.
## نحو
```ts
const { data, loading } = useWatchPluginMessage<T>();
```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 | نشاندهنده در حال بارگذاری بودن دادهها | 




