add TypeScript types #52
Conversation
src/installLogsPrinter.d.ts
Outdated
| * Output logs to files. [More details](https://github.com/archfz/cypress-terminal-report#logging-to-files). | ||
| * @default null | ||
| */ | ||
| outputTarget?: object | null; |
There was a problem hiding this comment.
Let's be more specific here. So Record<string, 'json' | 'txt' | (messages: Record<string, Record<string, [string, string, Severity]>) => string
There was a problem hiding this comment.
Please see revised revision - I didn't see the callback API mentioned in the readme, but maybe I just missed it. LMK if this is what you meant.
| @@ -1,14 +1,265 @@ | |||
| { | |||
There was a problem hiding this comment.
package-lock.json diff was generated automatically when adding cypress as a dev dependency.
| @@ -41,5 +41,8 @@ | |||
| }, | |||
| "peerDependencies": { | |||
| "cypress": ">=3.8.1" | |||
| }, | |||
| "devDependencies": { | |||
| "cypress": ">=3.8.1" | |||
There was a problem hiding this comment.
needed to be able to reference the built-in Cypress types (in src/installLogsPrinter.d.ts).
|
Looks good :) Thx. |
Thanks for going over it very quickly and merging it. I'll remove the relevant changes from our codebase once a new version is published. Also, I'd appreciate it if you could add the |
|
Should I also add to this pr the |
I don't think it's required, on the other hand - it can't hurt. According to their explanation (highlights are mine):
|
|
Added just to be sure. |
Thanks! There's a cooldown of 2 weeks before anything is eligible anyway it seems, but I don't expect any issues coming up. Will let you know if there are, at any rate. |
This PR aims to add TypeScript types for the two entry points. Very helpful given that Cypress has built-in TypeScript support for quite some time, and helps with configuring the plugin.
The docs for the properties are based on the README ones.