docs(getting-started): static files on CF Workers #247
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
there is a requirement to add a manifest to the serveStatic adapter method, the docs correctly shows that you need to import a manifest from the special __STATIC_CONTENT_MANIFEST module However, this results in a Typescript error, as this module is generated by wrangler. This change to the docs explains how the user can add a type definition so that the error goes away, otherwise they may assume that the example is incorrect.
yusukebe
reviewed
Feb 16, 2024
| @@ -183,6 +183,15 @@ app.get('/static/*', serveStatic({ root: './', manifest })) | |||
| app.get('/favicon.ico', serveStatic({ path: './favicon.ico' })) | |||
| ``` | |||
|
|
|||
| TypeScript cannot resolve the special __STATIC_CONTENT_MANIFEST variable used to import the manifest. This variable is specific to Cloudflare Workers' environment and isn't recognized by TypeScript out of the box. | |||
There was a problem hiding this comment.
You can write "__STATIC_CONTENT_MANIFEST" as a code span:
`__STATIC_CONTENT_MANIFEST`| @@ -183,6 +183,15 @@ app.get('/static/*', serveStatic({ root: './', manifest })) | |||
| app.get('/favicon.ico', serveStatic({ path: './favicon.ico' })) | |||
| ``` | |||
|
|
|||
| TypeScript cannot resolve the special __STATIC_CONTENT_MANIFEST variable used to import the manifest. This variable is specific to Cloudflare Workers' environment and isn't recognized by TypeScript out of the box. | |||
| You can tell TypeScript about this special module by declaring it in a type definition file. Create a new .d.ts file in your project, such as custom.d.ts, and add the following declaration: | |||
There was a problem hiding this comment.
It's better to use a code span for ".d.ts" too:
`.d.ts`
|
Hi @stukennedy Thanks! That's a good suggestion. I've left the comments. Please check them. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
there is a requirement to add a manifest to the serveStatic adapter method, the docs correctly shows that you need to import a manifest from the special __STATIC_CONTENT_MANIFEST module
However, this results in a Typescript error, as this module is generated by wrangler. This change to the docs explains how the user can add a type definition so that the error goes away, otherwise they may assume that the example is incorrect.