-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[#4461] Change typescript declaration for .writeFile() #4463
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d64a66b
[#4461] Change typescript declaration for .writeFile()
dmtrKovalenko 21ad09d
Fix dtslint error
dmtrKovalenko 60fd841
Add example to tsdoc definition
dmtrKovalenko f78f10c
Add testing example of new ts definition
dmtrKovalenko 588726b
Fix trailling whitespace
dmtrKovalenko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1776,13 +1776,21 @@ declare namespace Cypress { | |
}) | ||
``` | ||
*/ | ||
writeFile<C extends FileContents>(filePath: string, contents: C, options?: Partial<Loggable>): Chainable<C> | ||
writeFile<C extends FileContents>(filePath: string, contents: C, encoding: Encodings): Chainable<C> | ||
/** | ||
* Write to a file with the specified encoding and contents. | ||
* | ||
* @see https://on.cypress.io/writefile | ||
``` | ||
cy.writeFile('path/to/ascii.txt', 'Hello World', { | ||
flag: 'a+', | ||
encoding: 'ascii' | ||
}).then((text) => { | ||
expect(text).to.equal('Hello World') // true | ||
}) | ||
``` | ||
*/ | ||
writeFile<C extends FileContents>(filePath: string, contents: C, encoding: Encodings, options?: Partial<Loggable>): Chainable<C> | ||
writeFile<C extends FileContents>(filePath: string, contents: C, options?: Partial<WriteFileOptions>): Chainable<C> | ||
|
||
/** | ||
* jQuery library bound to the AUT | ||
|
@@ -2318,6 +2326,12 @@ declare namespace Cypress { | |
cancelable: boolean | ||
} | ||
|
||
/** Options to change the default behavior of .writeFile */ | ||
interface WriteFileOptions extends Loggable { | ||
flag: string | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. flag is only string even in native node's |
||
encoding: Encodings | ||
} | ||
|
||
// Kind of onerous, but has a nice auto-complete. Also fallbacks at the end for custom stuff | ||
/** | ||
* @see https://on.cypress.io/should | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add an example here?