felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 07:18:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Add more information for deprecated nFormat API (#1762)

Browse Source
This commit is contained in:
catloversg
2024-11-11 07:27:35 +07:00
committed by GitHub
parent f4c2b29d40
commit 650cf51acb
5 changed files with 20 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@@ -7637,16 +7637,22 @@ export interface NS {
formatPercent(n: number, fractionalDigits?: number, suffixStart?: number): string;
/**
* Format a number using the numeral library. This function is deprecated and will be removed in 2.4.
* @deprecated Use ns.formatNumber, formatRam, or formatPercent instead. Will be removed in 2.4.
* Format a number using the numeral library. This function is deprecated and will be removed in a later version.
*
* @deprecated
*
* Use alternatives:
*
* - NS APIs: ns.formatNumber, ns.formatRam, ns.formatPercent
*
* - JS built-in objects/functions: Intl.NumberFormat, Intl.PluralRules, Intl.Locale, etc.
*
* @remarks
* RAM cost: 0 GB
*
* Converts a number into a string with the specified format options.
* See http://numeraljs.com/#format for documentation on format strings supported.
*
* This function is deprecated and will be removed in 2.3.
*
* @param n - Number to format.
* @param format - Formatting options. See http://numeraljs.com/#format for valid formats.
* @returns Formatted number.