diff --git a/packages/bun-types/globals.d.ts b/packages/bun-types/globals.d.ts index 3f541166eaefae..6a65c9edfa3a78 100644 --- a/packages/bun-types/globals.d.ts +++ b/packages/bun-types/globals.d.ts @@ -1673,7 +1673,36 @@ declare global { groupEnd(): void; info(...data: any[]): void; log(...data: any[]): void; - /** Does nothing currently */ + /** + * Try to construct a table with the columns of the properties of `tabularData` (or use `properties`) and rows of `tabularData` and log it. Falls back to just + * logging the argument if it can't be parsed as tabular. + * + * ```js + * // These can't be parsed as tabular data + * console.table(Symbol()); + * // Symbol() + * + * console.table(undefined); + * // undefined + * + * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]); + * // ┌────┬─────┬─────┐ + * // │ │ a │ b │ + * // ├────┼─────┼─────┤ + * // │ 0 │ 1 │ 'Y' │ + * // │ 1 │ 'Z' │ 2 │ + * // └────┴─────┴─────┘ + * + * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']); + * // ┌────┬─────┐ + * // │ │ a │ + * // ├────┼─────┤ + * // │ 0 │ 1 │ + * // │ 1 │ 'Z' │ + * // └────┴─────┘ + * ``` + * @param properties Alternate properties for constructing the table. + */ table(tabularData?: any, properties?: string[]): void; /** * Begin a timer to log with {@link console.timeEnd}