VueVentus DocsdigitsOnly() Helper Method
The digitsOnly() Helper Method module provides a helper function that converts the first argument into a string and then tests it for purely digit characters. If the test passes, then the digits are returned, and otherwise the second argument is returned (which should be the original number).
This helper function is essentially a function tailored specifically for number counter UI validation.
Import
To import the digitsOnly() Helper Method:
javascript
import { digitsOnly } from '@obewds/vueventus'Arguments
Returns: Number
| Args | Type | Status | Description |
|---|---|---|---|
| value | Number or String | Required | The string or number to process |
| originalNumber | Number | Required | A fallback number if the 1st argument value has no positive integer characters |
Use Examples
javascript
const startNumber = 10
console.log( digitsOnly(11, startNumber) )
// returns (number): 11
console.log( digitsOnly(9, startNumber) )
// returns (number): 9
console.log( digitsOnly(11.123, startNumber) )
// returns (number): 10
console.log( digitsOnly('11.123', startNumber) )
// returns (number): 10
console.log( digitsOnly('abc', startNumber) )
// returns (number): 10Module Code
ts
// ./src/helpers/digitsOnly.ts
export default function (value: number|string, originalNumber: number): number {
const val = (String(value)).trim()
// Allow only be positive integer b/w 1 and 9
if (/^[1-9]\d*$/.test(val)) {
return Number(val)
} else {
return originalNumber
}
}