refactor: improve type definitions for ndarray array #1392
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
|
@Planeshifter could you kindly review this PR? |
kgryte
reviewed
Mar 17, 2024
| @@ -164,7 +164,7 @@ interface ExtendedOptions extends Options { | |||
| * var v = arr.get( 0 ); | |||
| * // returns [ 1, 2 ] | |||
| */ | |||
| declare function array<T = unknown>( options: OptionsWithShape | OptionsWithBuffer ): typedndarray<T>; | |||
| declare function array<T = unknown>( options: OptionsWithShape<T> | OptionsWithBuffer<T> ): typedndarray<typeof options['dtype'] extends undefined ? T : typeof options['dtype']>; | |||
There was a problem hiding this comment.
I am not sure I follow how the return type is supposed to work. Can you provide examples of what you believe to be expected behavior?
There was a problem hiding this comment.
You should also add corresponding tests to docs/types/test.ts to confirm expected behavior. All our TypeScript declarations should have corresponding unit tests.
kgryte
reviewed
Mar 17, 2024
| @@ -220,7 +220,7 @@ declare function array<T = unknown>( options: OptionsWithShape | OptionsWithBuff | |||
| * var v = arr.get( 0, 0 ); | |||
| * // returns 1.0 | |||
| */ | |||
| declare function array<T = unknown>( buffer: ArrayLike<any>, options?: ExtendedOptions ): typedndarray<T>; | |||
| declare function array<T = unknown>( buffer: ArrayLike<T>, options?: ExtendedOptions<T> ): typedndarray<T extends undefined ? ( typeof options extends { dtype: infer D } ? D : never ) : T >; | |||
kgryte
added
TypeScript
6 tasks
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.
Resolves #1088
Description
This pull request:
arrayfunction.dtype's value, else usesbufferarguments' type.Related Issues
This pull request:
@stdlib/ndarray/array#1088Questions
@Planeshifter From my understanding, I'm assuming the type of
bufferargument and the type ofbufferproperty inoptionsargument are the same? Please let me know if otherwise.Other
No.
Checklist
@stdlib-js/reviewers