Skip to content
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

Fix client allowing extraneous properties upon creation #367

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jpwilliams
Copy link
Member

Summary

Incorrect properties would be ignored and produce no type errors when creating a client via new Inngest(). For example, the following would show no errors, even though baseURL should be baseUrl:

new Inngest({
  id: "local-dev",
  name: "Local Dev",
  schemas: new EventSchemas().fromUnion<EventUnion>(),

  // Wrong but not error
  baseURL: "http://localhost:9999",
});

This PR ensures we're looking for the exact object instead.

Currently, we also ensure we allow excess properties if the options passed are a variable instead of an object literal, as this may indicate that the user wants to do more with the object.

Checklist

  • Added a docs PR that references this PR N/A Improvement
  • Added unit/integration tests
  • Added changesets if applicable

@jpwilliams jpwilliams added the ⬆️ improvement Performance, reliability, or usability improvements label Oct 19, 2023
@jpwilliams jpwilliams self-assigned this Oct 19, 2023
@changeset-bot
Copy link

changeset-bot bot commented Oct 19, 2023

⚠️ No Changeset found

Latest commit: 8f3c48b

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

@inngest-release-bot inngest-release-bot added the 📦 inngest Affects the `inngest` package label Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⬆️ improvement Performance, reliability, or usability improvements 📦 inngest Affects the `inngest` package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants