Skip to content

Fix incorrect method names in migration guide and update examples README#472

Open
peteroyce wants to merge 1 commit intodeepgram:mainfrom
peteroyce:fix/docs-migration-guide-and-examples-readme
Open

Fix incorrect method names in migration guide and update examples README#472
peteroyce wants to merge 1 commit intodeepgram:mainfrom
peteroyce:fix/docs-migration-guide-and-examples-readme

Conversation

@peteroyce
Copy link
Copy Markdown

Summary

  • Fixed incorrect WebSocket method names in the v4-to-v5 migration guide (docs/Migrating-v4-to-v5.md):
    • sendSpeakV1Text()sendText() (matching actual method in Socket.ts)
    • sendAgentV1Settings()sendSettings() (matching actual method in Socket.ts)
  • Updated examples/README.md:
    • Fixed all file extensions from .js to .ts to match actual files
    • Corrected wrong filenames for examples 25-27
    • Added missing examples 28-35
    • Fixed empty export statements with proper variable names
    • Updated outdated createClient reference to new DeepgramClient()

Test plan

  • Verify corrected method names match the actual SDK source in src/api/resources/
  • Confirm all example filenames in README match actual files in examples/

🤖 Generated with Claude Code

…s README

Fix incorrect WebSocket method names in the v4-to-v5 migration guide:
- `sendSpeakV1Text()` -> `sendText()` (Speak V1 socket)
- `sendAgentV1Settings()` -> `sendSettings()` (Agent V1 socket)

These method names did not match the actual SDK API, which would cause
errors for anyone following the migration guide.

Also fix examples/README.md:
- Change .js file extensions to .ts to match actual example files
- Fix wrong filenames for examples 25-27 (listed non-existent files)
- Add missing examples 26, 28-35 that were not documented
- Fix empty export statements in usage instructions
- Update outdated `createClient` reference to `new DeepgramClient()`

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@peteroyce peteroyce requested a review from lukeocodes as a code owner March 23, 2026 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant