initial ts documentation

[evanshortiss]

This should serve as a start for TypeScript documentation. We could link to it in a PR/Issue template?

[mcollina]

LGTM

[jsumners]

should "just work" when your used in a TypeScript application. => should "just work" when used in a TypeScript application.

[jsumners]

How about this instead?: Plugins may or may not include typings. See [Plugin Types](#plugin-types) for more information.

[jsumners]

Add <a id="typescript"></a> prior to this line.

[jsumners]

Add <a id="contributing"></a> prior to this line.

[jsumners]

Add <a id="core-types"></a> prior to this line.

[jsumners]

Add <a id="plugin-types"></a> prior to this line.

[jsumners]

Add <a id="authoring-plugin-types"></a> prior to this line.

[jsumners]

This example TypeScript app closely aligns with the JavaScript examples:

[jsumners]

Is it not possible to add some description to the core typings that allows for unknown methods/properties on the core objects?

[delvedor]

LGTM

[evanshortiss]

@jsumners will action those ASAP. Travelling today 👍

Is it not possible to add some description to the core typings that allows for unknown methods/properties on the core objects?

Do you mean such that a user could just do:

server.blah()

If they happened to need a quick way to do that it's possible in TS. Can do the following if you're super sure it'll be ok and not undefined etc:

(server as any).blah()

Or even better, you can extend the server interface in your own code. Here's a sample of doing so for a commander CLI I wrote a while back.

[jsumners]

I suggesting that the core declarations should allow for arbitrary methods/properties so that there doesn't have to be typings added for every plugin/decoration to ever be written for Fastify.

[evanshortiss]

I don't think that's an issue core can solve. It's an overall TS language thing where properties and interfaces need to be correctly defined.

We could add this to the Server definition:

[key: string]: any

Then developers could do things like:

server.a()
server.b()

But that would defeat the point of having stronger types in the first place.

[evanshortiss]

Accidentally fat fingered. Reopening.

[delvedor]

LGTM

[delvedor]

@evanshortiss can you address @jsumners's suggestions?
Then we can merge this :)

[evanshortiss]

👍 think we're good @delvedor @jsumners? I added one more section related to http prototypes

[jsumners]

👍

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.