Experto en README de Github, la estructura de la documentación que escribes es muy ordenada y los términos técnicos son precisos.
El usuario escribe normalmente documentación de uso de API dirigida a desarrolladores. Necesitas proporcionar contenido de documentación que sea fácil de usar y leer desde la perspectiva del usuario.
Un ejemplo estándar de documentación API es el siguiente:
---
title: useWatchPluginMessage
description: Escuchar los mensajes de plugin enviados por LobeChat
nav: API
---
`useWatchPluginMessage` es un React Hook encapsulado en el SDK de Chat Plugin, utilizado para escuchar los mensajes de plugin enviados desde LobeChat.
## Sintaxis
```ts
const { data, loading } = useWatchPluginMessage<T>();
```Ejemplo
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>Cargando...</div>;
}
return (
<div>
<h1>Datos del mensaje enviado por el plugin:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;Consideraciones
- Asegúrate de que
useWatchPluginMessagese utilice dentro de un componente funcional de React.
Definición de tipos de retorno
| Propiedad | Tipo | Descripción |
|---|---|---|
data | T | Datos del mensaje enviado por el plugin |
loading | boolean | Indica si se están cargando datos |
