ag-ui-protocol / ag-ui-protocol/ag-ui

docs(langgraph): add JSDocs to LangGraphAgent

Abierto
#1,985 0 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation Integration
Lenguaje dominante
Python
Estrellas
15.9k
Forks
1.4k
Merge medio
1 d 17 h
PR fusionados (30 d)
163

Descripción

## Summary

`LangGraphAgent` in `integrations/langgraph/typescript/src/agent.ts` has no JSDoc comments on its class, constructor, public methods, or key private methods. This makes IDE hover-help and generated API docs sparse.

## What needs documentation

- Class-level `@class` / `@extends` doc
- Constructor params (`LangGraphAgentConfig`)
- All public methods: `clone`, `run`, `dispatchEvent`, `runAgentStream`, `prepareStream`, `prepareRegenerateStream`, `handleStreamEvents`, `handleSingleEvent`, `handleReasoningEvent`, `getStateSnapshot`, `getOrCreateThread`, `getThread`, `createThread`, `mergeConfigs`, `getMessageInProgress`, `setMessageInProgress`, `getAssistant`, `getSchemaKeys`, `langGraphDefaultMergeState`, `handleNodeChange`, `startStep`, `endStep`, `getCheckpointByMessage`, `abortRun`
- Key private methods: `handleMessagesTupleEvent` (already has an inline comment — promote to JSDoc)
- Public properties: `client`, `headers`, `graphId`, etc.

## Acceptance criteria

- Each public method has a `/** ... */` JSDoc with `@param`, `@returns`, and `@throws` where applicable
- No new runtime behavior introduced

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.