shouldjs/should.js

Typings for custom assertions

Open

#174 建立於 2018年5月2日

在 GitHub 查看
 (2 留言) (0 反應) (1 負責人)JavaScript (1,906 star) (131 fork)batch import
enhancementhelp wanted

描述

Hi.

Node.js version?

8.11.1

Should.js version?

13.2.1

How to reproduce it?

When using shouldjs with Typescript and extending the should Assertions with a custom function: Lets say:

Assertion.add('asset', function() {
     this.params = { operator: 'to be asset' }

     this.obj.should.have.property('id').which.is.a.Number()
     this.obj.should.have.property('path')
})

Compiling Typescript will throw an error when using the should(obj).asset() function because it doesn't exist on the type Assertion. Simplest solution would by adding the following to the Assertion interface to allow dynamic properties:

[key: string]: any;

貢獻者指南

技術棧
typescriptnodejs
領域
developer experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
The fix is to add an index signature `[key: string]: any;` to the `Assertion` interface in the TypeScript type definition file for should.js, likely located in `types/should.d.ts`. The issue clearly states the required change. Since the issue is old and has an assignee, check if there is any existing PR or discussion about this. The change is trivial and localized.
Typings for custom assertions · shouldjs/should.js#174 | Good First Issue