MightyPork/profin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

note baout returning self

Browse Source
This commit is contained in:
MightyPork
2018-04-25 22:54:26 +02:00
parent ea54367fde
commit b37ea47e5d
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -3
View File
@@ -95,6 +95,9 @@ samples is an array of record when the abalnce changed that we cna plot using th
ProFin works with two types of objects: the profiler, and incomes. Expense is a negative income and is internally ProFin works with two types of objects: the profiler, and incomes. Expense is a negative income and is internally
represented the same way. represented the same way.
Generally all methods return the object itself for easy chaining, with the exception of Projector methods like `monthly`, `single` etc,
which are shortcuts for creating income instances.
### Projector API ### Projector API
- `pf.date(year, month, day)` - set time cursor. This is used for subsequently created incomes as a starting date, or - `pf.date(year, month, day)` - set time cursor. This is used for subsequently created incomes as a starting date, or
@@ -118,9 +121,9 @@ represented the same way.
### MonthlyIncome API ### MonthlyIncome API
- `mi.on(day)` - set the pay day in the month, returns self - `mi.on(day)` - set the pay day in the month
- `mi.skip_month(year, month)` - skip a month's payment, return self - `mi.skip_month(year, month)` - skip a month's payment
- `mi.start(year, month, day)` - set start date (month, day default to Jan 1), return self. - `mi.start(year, month, day)` - set start date (month, day default to Jan 1)
If no args given, take current cursor's date If no args given, take current cursor's date
- `mi.end(year, month, day)` - end the payments. If no args given, take last day of current cursor's month - `mi.end(year, month, day)` - end the payments. If no args given, take last day of current cursor's month
- `mi.total(total)` - set a total money cap, after it's exhausted the payments stop - `mi.total(total)` - set a total money cap, after it's exhausted the payments stop