Github 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 | Показва дали данните се зареждат |
