Modernize README. #231
Closed
Modernize README. #231
Conversation
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
awaterma
requested changes
Mar 3, 2022
Comment on lines
+20
to
+24
| var cookie = await cookiejar.setCookie(cookie, 'https://currentdomain.example.com/path'); | ||
| var cookies = await cookiejar.getCookies('https://example.com/otherpath'); | ||
| // Or with callbacks! | ||
| cookiejar.setCookie(cookie, 'https://currentdomain.example.com/path', function(err, cookie) { /* ... */ }); | ||
| cookiejar.getCookies('http://example.com/otherpath', function(err, cookies) { /* ... */ }); |
There was a problem hiding this comment.
Love the comments and examples here!
|
|
||
| # API | ||
| Inspired by [AVA's support policy](https://github.com/avajs/ava/blob/v4.0.0/docs/support-statement.md), we will follow the [node.js release schedule](https://github.com/nodejs/Release#release-schedule) and support versions that are in Active LTS or Maintenance. We will only drop support for older versions of node when we do a major release. |
There was a problem hiding this comment.
Suggested change
| Inspired by [AVA's support policy](https://github.com/avajs/ava/blob/v4.0.0/docs/support-statement.md), we will follow the [node.js release schedule](https://github.com/nodejs/Release#release-schedule) and support versions that are in Active LTS or Maintenance. We will only drop support for older versions of node when we do a major release. | |
| Similar to [AVA's support policy](https://github.com/avajs/ava/blob/v4.0.0/docs/support-statement.md), we follow the [node.js release schedule](https://github.com/nodejs/Release#release-schedule) and support all versions that are in Active LTS or Maintenance. We will only drop support for older versions of node when we do a major release and in consultation with our community. |
I really like the link to AVA's support statement, but we did decide on this policy awhile back. I've tried to make a suggestion that will retain the link, but change the statement to reflect the choices we made earlier a little clearer.
|
|
||
| Transforms a domain-name into a canonical domain-name. The canonical domain-name is a trimmed, lowercased, stripped-of-leading-dot and optionally punycode-encoded domain-name (Section 5.1.2 of RFC6265). For the most part, this function is idempotent (can be run again on its output without ill effects). | ||
| Transforms a domain-name into a canonical domain-name. The canonical domain-name is a domain-name that has been trimmed, lowercased, stripped of leading dot, and optionally punycode-encoded (Section 5.1.2 of RFC 6265). For the most part, this function is idempotent (calling the function with the output from a previous call will return the same output). |
There was a problem hiding this comment.
(I think this is a much clearer way to express idempotency, nice work)
|
Closed in favor of #234. |
wjhsf
pushed a commit
that referenced
this pull request
Feb 8, 2024
wjhsf
pushed a commit
that referenced
this pull request
Feb 8, 2024
…utomocks (#234) fixes #232 This PR reverts #231, #210, and #208. They provided functionality to auto mock apex methods. **Note:** Test authors will need to keep implementing their own apex (+apexContinuation) methods mocks after this PR is merged. * Revert "fix: apex automock should return a resolved promise (#231)" This reverts commit 544f95a. * Revert "fix: add apex stubs to the transformIgnorePatterns (#210)" This reverts commit fe8381a. * Revert "fix: automock apex methods with valid wire adapters (#208)" This reverts commit 125c689.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Focused on highlighting async methods over callbacks, while trying not to completely rewrite the doc. Also rewrote random other bits and pieces here and there.