fix: this.attribute(name) should fallback to Literal #353
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
Owner
cyjake
commented
Sep 27, 2022
cyjake
commented
cyjake
commented
Sep 27, 2022
| attribute<T, Key extends keyof T>(this: T, name: Key, value: T[Key]): void; | ||
| attribute<T, Key extends keyof T>(this: T, name: Key): T[Key]; | ||
| attribute<T, Key extends keyof T>(this: T, name: Key, value: Literal): void; | ||
| attribute<T, Key extends keyof T, U extends T[Key]>(this: T, name: Key): U extends Literal ? U : Literal; |
There was a problem hiding this comment.
If U is assignable to Literal, return U, else return Literal. This shall prevent this.attribute() calls in getter gives impractical type such as object | Function.
cyjake
commented
Sep 27, 2022
| @@ -48,7 +48,20 @@ describe('=> Basics (TypeScript)', function() { | |||
| summary: string; | |||
|
|
|||
| @Column(TEXT) | |||
| settings: string; | |||
| get settings(): Record<string, any> { | |||
| const text = this.attribute('settings') as string; | |||
There was a problem hiding this comment.
technically Record<string, any> is still assignable to LIteral but somehow this works, this.attribute('settings') returns Literal here.
There was a problem hiding this comment.
might because of the extra U extends T[Key] that derives a new type from T[Key]?
There was a problem hiding this comment.
it seems text's type is Literal | this["settings"]
```ts
class Foo {
@column(TEXT)
get settings(): Record<string, any> {
// this.attribute('settings') should return the original union type here
const text = this.attribute('settings') as string;
if (!text) return null;
try {
return JSON.parse(text);
} catch {
return null;
}
}
}
```
cyjake
force-pushed
the
limit-attribute-return-type-literal
branch
from
f6de25c to
4385c47
Compare
JimmyDaddy
approved these changes
Sep 27, 2022
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.