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

docs(langgraph): add JSDocs to LangGraphAgent

Aperta
#1,985 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation Integration
Lingua principale
Python
Stelle
15.9k
Fork
1.4k
Merge medio
1g 17h
PR unite (30g)
163

Descrizione

## 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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.