API: Format

numberFormat JavaScriptDart

Return number format including comma symbol.

Parameters

• number::number

Returns

string

Examples

_.numberFormat(1234567); // Returns 1,234,567

numberFormat(1234567); // Returns 1,234,567

fileName JavaScript

Extract the file name from the path. Include the extension if withExtension is true.

Parameters

• filePath::string
• withExtension::boolean || false

Returns

string

Examples

_.fileName('C:Temphello.txt'); // Returns 'hello.txt'
_.fileName('C:Temp\file.mp3', true); // Returns 'file.mp3'

fileSize JavaScript

Converts the file size in bytes to human-readable and returns it. The return value is a String and includes the file units (Bytes, MB, GB...). If the second optional argument value is included, you can display as many decimal places as you like.

Parameters

• bytes::number
• decimals::number || 2

Returns

string

Examples

_.fileSize(2000, 3); // Returns '1.953 KB'
_.fileSize(250000000); // Returns '238.42 MB'

fileExt JavaScript

Returns only the extensions in the file path. If unknown, returns 'Unknown'.

Parameters

• filePath::string

Returns

string

Examples

_.fileExt('C:Temphello.txt'); // Returns 'txt'
_.fileExt('this-is-file.mp3'); // Returns 'mp3'

duration JavaScript

Displays the given millisecond value in human-readable time. For example, the value of 604800000 (7 days) is displayed as 7 Days.

Parameters

• milliseconds::number
• options::DurationOptions | undefined

const {
	// Converts to `Days` -> `D`, `Hours` -> `H`,  `Minutes` -> `M`, `Seconds` -> `S`, `Milliseconds` -> `ms`
	useShortString = false,
	// Use space (e.g. `1Days` -> `1 Days`)
	useSpace = true,
	// Do not include units with a value of 0.
	withZeroValue = false,
	// Use Separator (e.g. If separator value is `-`, result is: `1 Hour 10 Minutes` -> `1 Hour-10 Minutes`)
	separator = ' '
}: DurationOptions = options;

Returns

string

Examples

_.duration(1234567890); // 'Returns '14 Days 6 Hours 56 Minutes 7 Seconds 890 Milliseconds'
_.duration(604800000, {
	useSpace: false
}); // Returns '7Days'

safeJSONParse JavaScript

Attempts to parse without returning an error, even if the argument value is of the wrong type or in JSON format. If parsing fails, it will be replaced with the object set in fallback. The default value for fallback is an empty object.

Parameters

• jsonString::any
• fallback::object

Returns

object

Examples

const result1 = _.safeJSONParse('{"a":1,"b":2}');
const result2 = _.safeJSONParse(null);

console.log(result1); // Returns { a: 1, b: 2 }
console.log(result2); // Returns {}

safeParseInt JavaScript

Any argument value will be attempted to be parsed as a Number type without returning an error. If parsing fails, it is replaced by the number set in fallback. The default value for fallback is 0. You can specify radix (default is decimal: 10) in the third argument.

Parameters

• value::any
• fallback::number
• radix::number

Returns

number

Examples

const result1 = _.safeParseInt('00010');
const result2 = _.safeParseInt('10.1234');
const result3 = _.safeParseInt(null, -1);

console.log(result1); // Returns 10
console.log(result2); // Returns 10
console.log(result3); // Returns -1