Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r-unic/rbx-formatting
Utility functions for formatting numbers and parsing strings back into numbers for Roblox
https://github.com/r-unic/rbx-formatting
Last synced: about 2 months ago
JSON representation
Utility functions for formatting numbers and parsing strings back into numbers for Roblox
- Host: GitHub
- URL: https://github.com/r-unic/rbx-formatting
- Owner: R-unic
- Created: 2024-12-03T23:40:52.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-03T23:44:29.000Z (about 2 months ago)
- Last Synced: 2024-12-03T23:45:16.623Z (about 2 months ago)
- Language: TypeScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @rbxts/formatting
Utility functions for formatting numbers and parsing strings back into numbers for Roblox
## commaFormat
Places commas between every three decimal points in `n`
### Parameters
* `n` **([number][19] | [string][20])**
### Examples
```javascript
commaFormat(1000000) // 1,000,000
```
Returns **[string][20]**
## abbreviate
Abbreviates numbers larger than or equal to `threshold`
### Parameters
* `n` **[number][19]**
* `threshold` (optional, default `100_000`)
* `suffixes` (optional, default `baseSuffixes`)
### Examples
```javascript
abbreviate(1000000) // 1M
abbreviate(1000000000000000000000) // 1Sx
```
Returns **[string][20]**
## parseAbbreviatedNumber
Parses a number formatted by `abbreviate()` back into a number type
### Parameters
* `suffixed` **[string][20]**
* `suffixes` (optional, default `baseSuffixes`)
### Examples
```javascript
parseAbbreviatedNumber("1B") // 1000000000
```
Returns **[number][19]**
## toSeconds
Takes a remaining time string and converts it to the amount of time it represents in seconds.
### Parameters
* `time` **[string][20]**
### Examples
```javascript
toSeconds("10m 20s") // 620
```
Returns **[number][19]**
## toRemainingTime
Takes a time in seconds and converts it to a remaining time string
### Parameters
* `seconds` **[number][19]**
* `secondsFormat` (optional, default `"%ds"`)
* `minutesFormat` (optional, default `"%dm"`)
* `hoursFormat` (optional, default `"%dh"`)
* `daysFormat` (optional, default `"%dd"`)
### Examples
```javascript
toRemainingTime(310) // 5m 10s
```
Returns **[string][20]**
## toLongRemainingTime
Takes a time in seconds and converts it to a long remaining time string
### Parameters
* `seconds` **[number][19]**
### Examples
```javascript
toLongRemainingTime(3690) // 01:01:30
```
Returns **[string][20]**
[1]: #commaformat
[2]: #parameters
[3]: #examples
[4]: #abbreviate
[5]: #parameters-1
[6]: #examples-1
[7]: #parseabbreviatednumber
[8]: #parameters-2
[9]: #examples-2
[10]: #toseconds
[11]: #parameters-3
[12]: #examples-3
[13]: #toremainingtime
[14]: #parameters-4
[15]: #examples-4
[16]: #tolongremainingtime
[17]: #parameters-5
[18]: #examples-5
[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String