mirror of
https://github.com/oven-sh/bun
synced 2026-02-12 03:48:56 +00:00
Improve TOML.stringify documentation with actual output example
- Show the actual TOML output in the example instead of explaining what doesn't work - Simplify parameter descriptions to be less confusing - Focus on what the function does rather than what it doesn't support 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
27
packages/bun-types/bun.d.ts
vendored
27
packages/bun-types/bun.d.ts
vendored
@@ -621,14 +621,11 @@ declare module "bun" {
|
||||
/**
|
||||
* Convert a JavaScript object to a TOML string.
|
||||
*
|
||||
* Similar to JSON.stringify but for TOML format. Supports optional replacer and space parameters
|
||||
* for API consistency, but replacer will throw an error and space is ignored.
|
||||
*
|
||||
* @category Utilities
|
||||
*
|
||||
* @param value The JavaScript object to stringify
|
||||
* @param replacer Currently unused - throws error if provided (for API consistency with JSON.stringify)
|
||||
* @param space Ignored - TOML has consistent formatting rules
|
||||
* @param replacer Optional replacer function (not supported, will throw if used)
|
||||
* @param space Optional space parameter (ignored, TOML has fixed formatting)
|
||||
* @returns A TOML string
|
||||
*
|
||||
* @example
|
||||
@@ -645,15 +642,19 @@ declare module "bun" {
|
||||
* }
|
||||
* };
|
||||
*
|
||||
* // Basic usage
|
||||
* console.log(TOML.stringify(obj));
|
||||
*
|
||||
* // JSON.stringify-style API (space parameter is ignored)
|
||||
* TOML.stringify(obj, null, 2); // Same output as TOML.stringify(obj)
|
||||
* TOML.stringify(obj, null, "\t"); // Same output as TOML.stringify(obj)
|
||||
*
|
||||
* // Replacer throws error
|
||||
* TOML.stringify(obj, () => {}); // Error: "TOML.stringify does not support the replacer argument"
|
||||
* // Output:
|
||||
* // title = "TOML Example"
|
||||
* //
|
||||
* // [database]
|
||||
* // server = "192.168.1.1"
|
||||
* // ports = [
|
||||
* // 8001,
|
||||
* // 8001,
|
||||
* // 8002
|
||||
* // ]
|
||||
* // connection_max = 5000
|
||||
* // enabled = true
|
||||
* ```
|
||||
*/
|
||||
export function stringify(value: any, replacer?: undefined | null, space?: string | number): string;
|
||||
|
||||
Reference in New Issue
Block a user