loopbackio / loopbackio/loopback-next
Confusing @model() syntax
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- TypeScript
- Star
- 5.1k
- Fork
- 1.1k
- Merge trung bình
- 2 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 27
Mô tả
In LB3, users could specify model settings at two levels: as a root property or inside options property.
See https://stackoverflow.com/q/53307168/69868 for an example of LB3 syntax applied in an LB4 project:
@model({
settings: {strict: false},
name: 'client',
plural: 'clients',
options: {
mongodb: {
collection: 'clients',
},
},
})
export class Client extends Entity {
// ...
}
I am proposing to make two changes in LB4 to help users coming from LB3:
-
Recognize
optionsthe same way assettings. In the example above,mongodbsettings are not picked by LB4 now. With the proposed change in place, LB4 will setcollectiontoclientsas expected. Alternatively, tell the user settingoptionsthat they are trying to set an unsupported model-definition property. This can be done at compiler level too. -
Allow settings to be provided as top-level properties, for example:
@model({ name: 'client', strict: false, mongodb: { collection: 'clients', }, }) export class Client extends Entity { // ... }
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 từ decorator @model() và theo dõi cách LB4 đọc các thiết lập của model, đồng thời so sánh hành vi đó với các ví dụ LB3 trong issue. Xác định xem các tùy chọn nên được chấp nhận hay từ chối và liệu có nên hỗ trợ các thiết lập cấp cao nhất hay không; công việc được xem là hoàn tất khi hành vi đã chọn được triển khai và xác minh cho các ví dụ Client.
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
- backend-api-design
- 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
- 25/100