microsoft / microsoft/TypeScript
Need way to express hybrid types that are indexable for a subset of properties
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.4k
- Merge trung bình
- 1 ngày 19 giờ
- Pull request đã merge (30 ngày)
- 117
Mô tả
Edit by @DanielRosenwasser: This might be thought of as a "rest index signature" or a catch-all index signature.
This is a feature request.
TypeScript Version: 2.4
Code
interface CSSProperties {
marginLeft?: string | number
[key: string]: CSSProperties
}
Based on the docs, this is not allowed:
While string index signatures are a powerful way to describe the “dictionary” pattern, they also enforce that all properties match their return type. This is because a string index declares that obj.property is also available as obj[“property”]. In the following example, name’s type does not match the string index’s type, and the type-checker gives an error:
Unfortunately, it seems to make this type (which is common amongst jss-in-css solutions) not expressible. Coming from flow, which handles index types by assuming they refer to the properties that are not explicitly typed, this is frustrating.
As it stands, you can workaround it with:
interface CSSProperties {
marginLeft?: string | number
[key: string]: CSSProperties | string | number
}
But this is not sound. It allows this:
const style: CSSProperties = {
margarineLeft: 3
}
This could potentially be solved with subtraction types if they allowed subtracting from string (and you were allowed to specify key types in this way):
interface CSSProperties {
marginLeft?: string | number
}
interface NestedCSSProperties extends CSSProperties {
[key: string - keyof CSSProperties]: CSSProperties
}
I asked about this on stackoverflow to confirm that I wasn't missing something. It seems I'm not, so I guess I'd consider this a suggestion/discussion starter, since it's probably not a "bug". Thanks!
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với các ví dụ về CSSProperties và hướng dẫn handbook được liên kết, sau đó tái hiện hành vi hiện tại của type-checker đối với các thuộc tính tường minh kết hợp với một index signature. Công việc được xem là hoàn tất khi có thể biểu diễn kiểu lai được yêu cầu đồng thời từ chối các thuộc tính không xác định có kiểu không tương thích, mà không dựa vào unsound union workaround.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- typescript
- Lĩnh vực
- compilers
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 28/100