microsoft / microsoft/TypeScript

Declaration merging: remove function overloads?

Đang mở
#19,064 13 bình luận 18 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Awaiting More Feedback Suggestion
Ngôn ngữ chính
Go
Star
111k
Fork
14.3k
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
132

Mô tả

Let's say one of the libs come with a function like this:

// library:
declare module 'example' {
    interface Animal { }
    export function sayHello(a: Animal);
}

I want to narrow down the type to just Dog. This is my module augmentation:

// app.ts
declare module 'example' {
    interface Dog extends Animal { }
    export function sayHello(a: Dog);
}

This merges the declarations to two function overloads:

sayHello(a: Dog);
sayHello(a: Animal);

I'd like to remove the generic Animal one to get stricter type checking of my code.

I couldn't find if this has been discussed before but I would find it useful quite often. Some examples would be:

  • express headers (string by default, I'd use union of string literals)
  • yargs args (I'd limit them to args specific to my app)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách nghiên cứu các ví dụ về declaration-merging và module-augmentation trong issue, bao gồm cả hành vi overload đối với express headers và yargs args. Công việc được hoàn thành khi có một cách được hỗ trợ để loại bỏ hoặc thu hẹp overload generic ban đầu, với việc kiểm tra nghiêm ngặt hơn đối với kiểu đã được augment.

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
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.