inngest / inngest-js

The developer platform for easily building reliable workflows with zero infrastructure for TypeScript & JavaScript
https://www.inngest.com/
GNU General Public License v3.0
414 stars 41 forks source link

name -> id for clientoptions in readme #524

Closed jacobheric closed 6 months ago

jacobheric commented 6 months ago

Summary

I pulled latest and tried the example code in the readme's getting started:

const inngest = new Inngest({ name: "My App" });

and got:

src/index.ts:147:31 - error TS2345: Argument of type '{ name: string; }' is not assignable to parameter of type 'ClientOptions'.
  Object literal may only specify known properties, and 'name' does not exist in type 'ClientOptions'.

147 const inngest = new Inngest({ name: "My App" });

Guessing the readme has drifted from the code and it should be id and not name.

Checklist

Related

changeset-bot[bot] commented 6 months ago

⚠️ No Changeset found

Latest commit: 5a9a6cd890028e499c157c6fc5a4c3568b42cd2c

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

djfarrelly commented 6 months ago

Thank you @jacobheric!