Skip to content
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

Common tsdocs #68

Merged
merged 4 commits into from
Oct 20, 2023
Merged

Common tsdocs #68

merged 4 commits into from
Oct 20, 2023

Conversation

SepehrGanji
Copy link
Collaborator

No description provided.

@SepehrGanji SepehrGanji requested a review from arobsn October 12, 2023 17:31
@changeset-bot
Copy link

changeset-bot bot commented Oct 12, 2023

⚠️ No Changeset found

Latest commit: 4a2562e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov-commenter
Copy link

Codecov Report

Merging #68 (efa2416) into master (80daecc) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##            master       #68    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           98        98            
  Lines        14386     14720   +334     
  Branches      1316      1316            
==========================================
+ Hits         14386     14720   +334     
Files Coverage Δ
packages/common/src/models/collection.ts 100.00% <100.00%> (ø)
packages/common/src/utils/array.ts 100.00% <100.00%> (ø)
packages/common/src/utils/bigInt.ts 100.00% <100.00%> (ø)
packages/common/src/utils/object.ts 100.00% <100.00%> (ø)
packages/common/src/utils/utxo.ts 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@arobsn arobsn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!

  • Left some comments in the code
  • Please use @throw tag when applicable

* const array = [1, 2, 3, 4, 5];
* const chunks = chunk(array, 2);
* console.log(chunks);
* // [[1, 2], [3, 4], [5]]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@@ -81,6 +121,22 @@ export function orderBy<T>(
});
}

/**
* Returns true if arrays are equal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about using "Checks" instead of "Returns true" for this and other cases?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's a good idea,
Refactored!

@arobsn arobsn linked an issue Oct 18, 2023 that may be closed by this pull request
@arobsn arobsn removed a link to an issue Oct 18, 2023
@SepehrGanji SepehrGanji requested a review from arobsn October 18, 2023 17:22
@arobsn arobsn merged commit f30b743 into master Oct 20, 2023
6 checks passed
@arobsn arobsn deleted the common-tsdocs branch October 20, 2023 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants