Deprecate predictable helper methods #233
Merged
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.
Deprecated methods/properties such as:
payment.isOpen()
(synonymous withpayment.status == PaymentStatus.open
)list.count
(synonymous withlist.length
)error.getMessage()
(synonymous witherror.message
)Cons
Pros
length
and acount
, they might wonder "What is the difference between these two? Perhapslength
is the number of elements in this array, wherecount
is the total number of elements available?" Methods/properties with such simple synonyms can cause confusion.isOpen
,isAuthorized
,isExpired
,isFailed
,isPending
,hasSequenceTypeFirst
, andhasSequenceTypeRecurring
, it's easier to findgetCheckoutUrl
andgetRefunds
. It's easier to find the needle if the haystack is smaller.