Change types for createDerivedMaterial to be optional #307
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.
I ran into type issues when I was working with createDerivedmaterial and I found a relatively simple solution for them. I'm not very accustomed to using JSDoc, so let me know if I'm horribly wrong here but it looks good for me. Here's a quick rundown:
In a fresh Typescript (sveltekit) project I get the classic "Could not find a declaration file for module 'troika-three-utils'", despite it being type with JSDocs. I found that adding
"maxNodeModuleJsDepth": 1
in tsconfig fixes the issue. (Could be worth adding to docs, I didn't do that yet)With that out of the way, I am now getting type checking and autocomplete but all of the defined types for
createDerivedMaterial
options are required. I found that adding=
after the specified type makes it optional.https://jsdoc.app/tags-param#optional-parameters-and-default-values
As a result, after adding
"maxNodeModuleJsDepth": 1
to tsconfig and applying my proposed changes I get correct types