Skip to content

Commit

Permalink
Fix jsdoc spacing
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinongko committed Jan 11, 2017
1 parent dc63810 commit 787d5d9
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 56 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,69 +45,69 @@ export default {
## Props
```js
/**
* Currency symbol.
*/
* Currency symbol.
*/
currency: {
default: '',
required: false,
type: String
},

/**
* Default value.
*/
* Default value.
*/
default: {
required: false,
type: [Number, String]
},

/**
* Maximum value allowed.
*/
* Maximum value allowed.
*/
max: {
required: false,
type: [Number, String]
},

/**
* Minimum value allowed.
*/
* Minimum value allowed.
*/
min: {
default: 0,
required: false,
type: [Number, String]
},

/**
* Enable/Disable minus value.
*/
* Enable/Disable minus value.
*/
minus: {
default: true,
required: false,
type: Boolean
},

/**
* Input placeholder.
*/
* Input placeholder.
*/
placeholder: {
required: false,
type: String
},

/**
* Number of decimals.
* Decimals symbol are the opposite of separator symbol.
*/
* Number of decimals.
* Decimals symbol are the opposite of separator symbol.
*/
precision: {
required: false,
type: [Number, String]
},

/**
* Thousand separator type.
* Separator props accept either . or , (default).
*/
* Thousand separator type.
* Separator props accept either . or , (default).
*/
separator: {
default: ',',
required: false,
Expand Down
76 changes: 38 additions & 38 deletions src/vue-numeric.vue
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ export default {
},
/**
* v-model value.
*/
* v-model value.
*/
value: {
required: true,
type: [Number, String]
Expand All @@ -94,53 +94,53 @@ export default {
computed: {
/**
* Number formatted user typed value.
* @return {Number}
*/
* Number formatted user typed value.
* @return {Number}
*/
amountValue () {
return this.formatToNumber(this.amount)
},
/**
* Number formatted default value.
* @return {Number}
*/
* Number formatted default value.
* @return {Number}
*/
defaultValue () {
if (this.default) return this.formatToNumber(this.default)
return 0
},
/**
* Number formatted minimum value.
* @return {Number}
*/
* Number formatted minimum value.
* @return {Number}
*/
minValue () {
if (this.min) return this.formatToNumber(this.min)
return 0
},
/**
* Number formatted maximum value.
* @return {Number|undefined}
*/
* Number formatted maximum value.
* @return {Number|undefined}
*/
maxValue () {
if (this.max) return this.formatToNumber(this.max)
return undefined
},
/**
* Define decimal separator based on separator props.
* @return {String} '.' or ','
*/
* Define decimal separator based on separator props.
* @return {String} '.' or ','
*/
decimalSeparator () {
if (this.separator === '.') return ','
return '.'
},
/**
* Define thousand separator based on separator props.
* @return {String} '.' or ','
*/
* Define thousand separator based on separator props.
* @return {String} '.' or ','
*/
thousandSeparator () {
if (this.separator === '.') return '.'
return ','
Expand All @@ -149,10 +149,10 @@ export default {
methods: {
/**
* Check provided value againts maximum allowed.
* @param {Number} value
* @return {Boolean}
*/
* Check provided value againts maximum allowed.
* @param {Number} value
* @return {Boolean}
*/
checkMaxValue (value) {
if (this.max) {
if (value <= this.maxValue) return false
Expand All @@ -162,10 +162,10 @@ export default {
},
/**
* Check provided value againts minimum allowed.
* @param {Number} value
* @return {Boolean}
*/
* Check provided value againts minimum allowed.
* @param {Number} value
* @return {Boolean}
*/
checkMinValue (value) {
if (this.min) {
if (value >= this.minValue) return false
Expand All @@ -175,10 +175,10 @@ export default {
},
/**
* Format provided value to number type.
* @param {String} value
* @return {Number}
*/
* Format provided value to number type.
* @param {String} value
* @return {Number}
*/
formatToNumber (value) {
let number = 0
Expand All @@ -193,9 +193,9 @@ export default {
},
/**
* Validate value before apply to the component.
* @param {Number} value
*/
* Validate value before apply to the component.
* @param {Number} value
*/
processValue (value) {
if (isNaN(value)) {
this.updateValue(this.minValue)
Expand All @@ -209,9 +209,9 @@ export default {
},
/**
* Apply value to component.
* @param {Number} value
*/
* Apply value to component.
* @param {Number} value
*/
updateValue (value) {
this.amount = accounting.formatMoney(value, {
symbol: this.currency + ' ',
Expand Down

0 comments on commit 787d5d9

Please sign in to comment.