Typescript types #24
Merged
Typescript types #24
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
andersonjoseph
force-pushed
the
typescript-support
branch
from
c687ac9
to
03a4a27
Compare
andersonjoseph
force-pushed
the
typescript-support
branch
from
03a4a27
to
cb1a3ac
Compare
Eomm
reviewed
Jul 12, 2023
Co-authored-by: Manuel Spigolon <behemoth89@gmail.com>
Eomm
reviewed
Jul 23, 2023
types/index.d.ts
Outdated
| * @param {FormMethodOptions} opts - An object containing properties to modify the output field names. | ||
| * @returns {FormMethodResult} A JSON object with a payload field representing the data stream and a headers field containing the content-type set to "application/json". | ||
| */ | ||
| export default function formMethod<const T extends FormMethodOptions = FormMethodDefaultOptions>(json: Record<string, unknown>, opts?: T): FormMethodResult<T> |
There was a problem hiding this comment.
This is working (note the wrong option):
const myForm = formAutoContent({
field1: 'value1',
field2: ['value2', 'value2.2']
}, { headers: 'head', foo: '' });
Could we handle it?
There was a problem hiding this comment.
I found a way to handle this case but with a con: TS won't be able to infer the correct type when using an inline object without a const assertion because the type is widened when using the helper WithoutExtraProperties.
However, I realized this could be 'good' as the feature I'm using to infer the types in inline objects is a new feature from TS 5.0, so without this feature we can support pre TS 5.0 codebases
andersonjoseph
force-pushed
the
typescript-support
branch
from
fc8d4da
to
2f83280
Compare
Eomm
approved these changes
Jul 25, 2023
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.
Hi馃憢
This PR adds TypeScript declaration file, some tests, and documentation.
Let me know if something is missing or needs to be changed.
Fixes: #19