UNPKG

biorhythm-calculator

Version:

Comprehensive set of functions and helpers to check multiple biorhythm-related data

90 lines (63 loc) • 3.72 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
## Functions <dl> <dt><a href="#createCalculator">createCalculator(daysDifference)</a> ⇒ <code>function</code></dt> <dd><p>Creates a biorhythm calculator based on the days passed since birth</p> </dd> <dt><a href="#calculateBiorhythm">calculateBiorhythm(dateOfBirth, dateToAnalyze)</a> ⇒ <code><a href="#BiorhythmResult">BiorhythmResult</a></code></dt> <dd><p>Calculates biorhythm based on birth date and a custom date</p> </dd> <dt><a href="#calculateBiorhythmRange">calculateBiorhythmRange(dateOfBirth, dateToAnalyze, amountOfDays)</a> ⇒ <code><a href="#BiorhythmRangeResult">Array.&lt;BiorhythmRangeResult&gt;</a></code></dt> <dd><p>Gets biorhythms for date range</p> </dd> </dl> ## Typedefs <dl> <dt><a href="#BiorhythmResult">BiorhythmResult</a></dt> <dd></dd> <dt><a href="#BiorhythmRangeResult">BiorhythmRangeResult</a></dt> <dd></dd> </dl> <a name="createCalculator"></a> ## createCalculator(daysDifference) ⇒ <code>function</code> Creates a biorhythm calculator based on the days passed since birth **Kind**: global function **Returns**: <code>function</code> - Calculator function | Param | Type | Description | | -------------- | ------------------- | ---------------- | | daysDifference | <code>number</code> | Days since birth | <a name="calculateBiorhythm"></a> ## calculateBiorhythm(dateOfBirth, dateToAnalyze) ⇒ [<code>BiorhythmResult</code>](#BiorhythmResult) Calculates biorhythm based on birth date and a custom date **Kind**: global function **Returns**: [<code>BiorhythmResult</code>](#BiorhythmResult) - Object that represents the day's status | Param | Type | Description | | ------------- | ----------------- | ---------------------------------------- | | dateOfBirth | <code>Date</code> | The date of birth, as Date | | dateToAnalyze | <code>Date</code> | The date to obtain the biorhythm data on | <a name="calculateBiorhythmRange"></a> ## calculateBiorhythmRange(dateOfBirth, dateToAnalyze, amountOfDays) ⇒ [<code>Array.&lt;BiorhythmRangeResult&gt;</code>](#BiorhythmRangeResult) Gets biorhythms for date range **Kind**: global function **Returns**: [<code>Array.&lt;BiorhythmRangeResult&gt;</code>](#BiorhythmRangeResult) - Objects array that represents the days' status | Param | Type | Description | | ------------- | ------------------- | -------------------------------------------------------------------------------------------------------- | | dateOfBirth | <code>Date</code> | The date of birth, as Date | | dateToAnalyze | <code>Date</code> | The date to obtain the biorhythm data on | | amountOfDays | <code>number</code> | Number of days to add in range (Ex. 3 will give desired date as well as 3 days before, and 3 days after) | <a name="BiorhythmResult"></a> ## BiorhythmResult **Kind**: global typedef **Properties** | Name | Type | | ------------ | ------------------- | | physical | <code>number</code> | | emotional | <code>number</code> | | intellectual | <code>number</code> | <a name="BiorhythmRangeResult"></a> ## BiorhythmRangeResult **Kind**: global typedef **Properties** | Name | Type | | --------- | ------------------------------------------------ | | day | <code>Date</code> | | biorhythm | [<code>BiorhythmResult</code>](#BiorhythmResult) |