Skip to content

Commit c1d3984

Browse files
committed
docs: add return types in measurements.md
1 parent 9a83c3f commit c1d3984

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

docs/measurements.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ parent element's dimensions can be properly transitioned
1313
- [measurements](#measurements)
1414
- [measured](#measured)
1515
- [validateDimension(dimension)](#validatedimension-dimension)
16-
- [getMarginNumericValue(margin)](#getmarginnumericvalue-margin)
17-
- [getVertMargin(margins, arrLength)](#getvertmargin-margins-arrlength)
18-
- [getHorizMargin(margins, arrLength)](#gethorizmargin-margins-arrlength)
19-
- [getElementMargins(element, axis)](#getelementmargins-element-axis)
20-
- [getElementMeasure(element, dimension)](#getelementmeasure-element-dimension)
21-
- [getParentMeasure(element, dimension)](#getparentmeasure-element-dimension)
22-
- [getParentMeasures(element)](#getparentmeasures-element)
16+
- [getMarginNumericValue(margin)](#getmarginnumericvalue-margin) ⇒ <code>number</code>
17+
- [getVertMargin(margins, arrLength)](#getvertmargin-margins-arrlength) ⇒ <code>number</code>
18+
- [getHorizMargin(margins, arrLength)](#gethorizmargin-margins-arrlength) ⇒ <code>number</code>
19+
- [getElementMargins(element, axis)](#getelementmargins-element-axis) ⇒ <code>number</code>
20+
- [getElementMeasure(element, dimension)](#getelementmeasure-element-dimension) ⇒ <code>number</code>
21+
- [getParentMeasure(element, dimension)](#getparentmeasure-element-dimension) ⇒ <code>Object</code>
22+
- [getParentMeasures(element)](#getparentmeasures-element) ⇒ <code>Object</code>
2323
- [setDimensionMax(element, dimension, value)](#setdimensionmax-element-dimension-value)
2424
- [removeDimensionMax(element, dimension)](#removedimensionmax-element-dimension)
2525
- [setParentMaxMeasures(args)](#setparentmaxmeasures-args)
@@ -41,7 +41,7 @@ Throws a ReferenceError if 'dimension' is neither 'width' nor 'height'
4141
| --------- | ------------------- | -------------------------- |
4242
| dimension | <code>string</code> | Either 'width' or 'height' |
4343

44-
### getMarginNumericValue(margin)
44+
### getMarginNumericValue(margin) ⇒ <code>number</code>
4545

4646
Returns only the numeric part of the margin property
4747

@@ -52,7 +52,7 @@ Returns only the numeric part of the margin property
5252
| ------ | ------------------- | -------------------------------- |
5353
| margin | <code>string</code> | Margin value along with its unit |
5454

55-
### getVertMargin(margins, arrLength)
55+
### getVertMargin(margins, arrLength) ⇒ <code>number</code>
5656

5757
Calculates the total margin of an element in the vertical axis
5858

@@ -64,7 +64,7 @@ Calculates the total margin of an element in the vertical axis
6464
| margins | <code>Array.&lt;string&gt;</code> | Array containing an element's margin values |
6565
| arrLength | <code>number</code> | Number of values declared in the CSS margin property |
6666

67-
### getHorizMargin(margins, arrLength)
67+
### getHorizMargin(margins, arrLength) ⇒ <code>number</code>
6868

6969
Calculates the total margin of an element in the horizontal axis
7070

@@ -76,7 +76,7 @@ Calculates the total margin of an element in the horizontal axis
7676
| margins | <code>Array.&lt;string&gt;</code> | Array containing an element's margin values |
7777
| arrLength | <code>number</code> | Number of values declared in the CSS margin property |
7878

79-
### getElementMargins(element, axis)
79+
### getElementMargins(element, axis) ⇒ <code>number</code>
8080

8181
Element's total margin in a given axis
8282

@@ -88,7 +88,7 @@ Element's total margin in a given axis
8888
| element | <code>HTMLElement</code> | The DOM element to calculate margins from |
8989
| axis | <code>string</code> | 'horizontal' or 'vertical' margins |
9090

91-
### getElementMeasure(element, dimension)
91+
### getElementMeasure(element, dimension) ⇒ <code>number</code>
9292

9393
Calculates the total width or height of an element
9494

@@ -100,7 +100,7 @@ Calculates the total width or height of an element
100100
| element | <code>HTMLElement</code> | The Dom element to measure |
101101
| dimension | <code>string</code> | Either 'width' or 'height' |
102102

103-
### getParentMeasure(element, dimension)
103+
### getParentMeasure(element, dimension) ⇒ <code>Object</code>
104104

105105
Calculates the element's parent dimension before and after 'element' is set to 'display: none'
106106

@@ -112,7 +112,7 @@ Calculates the element's parent dimension before and after 'element' is set to '
112112
| element | <code>HTMLElement</code> | The DOM element from which the parent will be measured |
113113
| dimension | <code>string</code> | Either 'width' or 'height' |
114114

115-
### getParentMeasures(element)
115+
### getParentMeasures(element) ⇒ <code>Object</code>
116116

117117
Calculates the width and height of an element's parent,
118118
before and after the element is set to 'display: none'

js-css-animations/measurements.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ const getHorizMargin = (margins, arrLength) => {
6666
* Element's total margin in a given axis
6767
* @param {HTMLElement} element - The DOM element to calculate margins from
6868
* @param {string} axis - 'horizontal' or 'vertical' margins
69-
* @returns Total margin in a given axis
69+
* @returns {number} Total margin in a given axis
7070
*/
7171
const getElementMargins = (element, axis) => {
7272
const calcMargins = {

0 commit comments

Comments
 (0)