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

docs(langgraph): add JSDocs to LangGraphAgent

Đang mở
#1,985 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation Integration
Ngôn ngữ chính
Python
Star
15.9k
Fork
1.4k
Merge trung bình
1 ngày 17 giờ
Pull request đã merge (30 ngày)
163

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.