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.

Sign up for GitHub

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

Jump to bottom

Docs: Add description for methods #36

Closed
37 of 38 tasks
frolovdev opened this issue May 14, 2020 · 2 comments · Fixed by #53
Closed
37 of 38 tasks

Docs: Add description for methods #36

frolovdev opened this issue May 14, 2020 · 2 comments · Fixed by #53
Labels
documentation Improvements or additions to documentation

Comments

@frolovdev
Copy link
Owner

frolovdev commented May 14, 2020 •
edited
Loading

Need to add some description and texts for methods. It can help new users to understand faster in use of functions of the library.
image

Functions

  • createMoney
  • createMoneyIntlFormatter
  • createMoneyCryptoFormatter
  • createBigNumberMoney
  • createBigIntMoney
  • createCurrencyList
  • createAgregatedCurrencyList
  • createCalculator
  • createMoneyUnit

Methods

money

  • add
  • subtract
  • absolute
  • allocate
  • isSameCurrency
  • equals
  • greaterThan
  • greaterThanOrEqual
  • allocateTo
  • compare
  • divide
  • getAmount
  • getCurrency
  • isNegative
  • isPositive
  • isSameCurrency
  • isZero
  • lessThan
  • lessThanOrEqual
  • mod
  • multiply
  • negative
  • ratioOf

formatter

  • format

crypto-formatter

  • format

currencies

  • contains
  • getCurrencies
  • subUnitFor
  • convertCurrencyMapToArray

(The methods will be supplemented as we move forward.)

Good examples could be found here
http://moneyphp.org/en/stable/
@frolovdev frolovdev added the documentation Improvements or additions to documentation label May 14, 2020
@Artem676 Artem676 mentioned this issue May 26, 2020
Merged
@frolovdev frolovdev reopened this May 26, 2020
@frolovdev
Copy link
Owner Author

Create a separate issue for createMoneyUnit

@frolovdev
Copy link
Owner Author

Closed in favor of #55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs Artem676/easymoney
1 participant
@frolovdev