search

sailhouse / docs

docs
2 stars 1 forks source link

TypeScript SDK approach #8

Open whitep4nth3r opened 10 months ago

whitep4nth3r commented 10 months ago

The docs mention the TypeScript SDK, yet provide an example to connect to Sailhouse in JavaScript.

image

Should we name this the JavaScript SDK with TypeScript support?

If it has full TypeScript support, do we have a types package included or separate?

Just mentioning TypeScript might scare newer developers away. The fact that I used the TypeScript SDK just by writing JavaScript is a bonus and it would be a benefit to mention/reword as such.

estephinson commented 10 months ago

Yeah this is a great point - it's a TS friendly library, but as always, it's just our lil JavaScript friend under the hood.

I've updated the docs to be a bit more inclusive of JS in the titles, and referenced it directly on the homepage. I'm still keen to use the word TypeScript from the out to highlight it is typed out of the box, but reassuring people that you can fallback to our trusty untyped friend if you would like!