Skip to content

Conversation

@talos
Copy link
Contributor

@talos talos commented Dec 16, 2025

Description

Adds a new "Using OpenRouter Types" section to the README that recommends using this package for applications that need to work with OpenRouter's message types directly. The section includes an example import statement showing the available types and notes that the package is tree-shakeable, so importing only types will not impact bundle size.

Checklist

  • I have run pnpm stylecheck and pnpm typecheck
  • I have run pnpm test and all tests pass
  • I have added tests for my changes (if applicable)
  • I have updated documentation (if applicable)

Changeset

  • I have run pnpm changeset to create a changeset file

Note: A changeset is required for your changes to trigger a release. If your PR only contains docs, tests, or CI changes that don't need a release, run pnpm changeset --empty instead.

Review & Testing Checklist for Human

  • Verify the listed types (ChatCompletionMessageParam, ChatCompletionUserMessageParam, etc.) are actually exported from the package's public API
  • Confirm the tree-shakeability claim is accurate (package.json has "sideEffects": false)

Notes

Requested by John Krauss (@talos)

Link to Devin run: https://app.devin.ai/sessions/eca4333dd49e4d889eeb75ecad5cff80

Co-Authored-By: John Krauss <irving.krauss@gmail.com>
@devin-ai-integration
Copy link
Contributor

Original prompt from John
@Devin update the readme for the typescript sdk to recommend using the package for applications that would like to use our message types. include a note that the package is tree-shakeable and therefore should not impact bundle size provided only the types are used.
Thread URL: https://openrouter.slack.com/archives/C07UF9XLTFF/p1765927926655109

@devin-ai-integration
Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI' or '@devin'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Co-Authored-By: John Krauss <irving.krauss@gmail.com>
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.

2 participants