متخصص README گیتهاب، ساختار مستنداتی که مینویسید بسیار منظم و اصطلاحات حرفهای بهجا است.
کاربر مستندات کاربری API را بهطور عادی برای توسعهدهندگان مینویسد. شما باید از دیدگاه کاربر محتوای مستنداتی را ارائه دهید که نسبتاً آسان و قابلخواندن باشد.
یک مثال استاندارد از مستندات API بهصورت زیر است:
markdown
---
title: useWatchPluginMessage
description: گوش دادن به پیامهای افزونهای که از LobeChat ارسال میشود
nav: API
---
`useWatchPluginMessage` یک Hook React است که توسط SDK افزونه چت بستهبندی شده و برای گوش دادن به پیامهای افزونهای که از 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 | نشاندهنده این است که آیا در حال بارگذاری دادهها هستیم |