Skip to content

Allow generating class sdks that are instantiable #1932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ibash
Copy link

@ibash ibash commented Apr 9, 2025

This adds an option asInstance that makes the sdk class instantiable. Specifically:

  1. Methods are instance methods instead of static
  2. The sdk takes a client as a parameter in the constructor, and sdk methods use the instance of the client.

This allows creating multiple instances of the sdk that work independently. My use case is using a client during server side rendering where each sdk instance is authenticated with the end-user's auth token which has limited permissions (as opposed to using a single client with admin permissions).

Contributes #671

I could use some guidance on how to add a snapshot test for this.

This adds an option asInstance that makes the sdk class instantiable.
Specifically:

1. Methods are instance methods instead of static
2. The sdk takes a client as a parameter in the constructor, and sdk
   methods use the instance of the client.

This allows creating multiple instances of the sdk that work
independently. My use case is using a client during server side
rendering where each sdk instance is authenticated with the end-user's
auth token which has limited permissions (as opposed to using a single
client with admin permissions).

Contributes hey-api#671
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Apr 9, 2025

⚠️ No Changeset found

Latest commit: d574901

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Apr 9, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hey-api-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 9, 2025 1:58am

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