console-toolkit 1.2.8 → 1.2.10

package/src/charts/bars/draw-stacked.d.ts

@@ -0,0 +1,47 @@
+import {ChartDatum, ChartDataInput, ChartTheme, DrawItemInfo} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+
+/** Options for stacked bar/column charts. */
+export interface StackedChartOptions {
+  /** Maximum value for scaling (default: auto). */
+  maxValue?: number;
+  /** Gap between rows in lines. */
+  gap?: number;
+  /** Chart theme. */
+  theme?: ChartTheme;
+  /** Custom draw function for individual items.
+   * @param datum - The chart data item or null.
+   * @param size - Allocated size in characters.
+   * @param info - Drawing info.
+   * @param options - Options.
+   * @returns The drawn string.
+   */
+  drawItem?: (datum: ChartDatum | null, size: number, info: DrawItemInfo, options: StackedChartOptions) => string;
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+  /** Additional custom options. */
+  [key: string]: unknown;
+}
+
+/** Function that draws a single row of a chart.
+ * @param data - Array of chart data items.
+ * @param width - Available width in characters.
+ * @param maxValue - Maximum value for scaling.
+ * @param options - Optional chart options.
+ * @returns The drawn row as a string or string array.
+ */
+type DrawRowFn = (data: ChartDatum[], width: number, maxValue: number, options?: StackedChartOptions) => string | string[];
+
+/** Creates a stacked bar chart drawing function from a row-drawing function.
+ * @param drawRow - The row-drawing function.
+ * @returns A chart-drawing function.
+ */
+export function drawChart(
+  drawRow: DrawRowFn
+): (values: ChartDataInput, width: number, options?: StackedChartOptions) => string[];
+
+export default drawChart;

package/src/charts/bars/draw-stacked.js

@@ -1,6 +1,10 @@
 import defaultTheme from '../themes/default.js';
 import {normalizeData, sumValues} from '../utils.js';
 
+/** Creates a stacked bar chart drawing function from a row-drawing function.
+ * @param {Function} drawRow - Function `(data, width, maxValue, options) => string|string[]`.
+ * @returns {Function} Chart drawing function `(values, width, options) => string[]`.
+ */
 export const drawChart =
   drawRow =>
   (values, width, options = {}) => {

package/src/charts/bars/frac-grouped.d.ts

@@ -0,0 +1,32 @@
+import {ChartDatum, ChartDataInput} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+import {GroupedChartOptions} from './draw-grouped.js';
+
+/** Options for fractional grouped bar charts. */
+export interface FracGroupedBarOptions extends GroupedChartOptions {
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+}
+
+/** Draws a single grouped bar row using fractional width block characters.
+ * @param data - Chart data items.
+ * @param width - Available width.
+ * @param maxValue - Maximum value.
+ * @param options - Options.
+ * @returns Array of strings for the row.
+ */
+export function drawRow(data: ChartDatum[], width: number, maxValue: number, options?: FracGroupedBarOptions): string[];
+
+/** Draws a complete fractional grouped bar chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: FracGroupedBarOptions): string[];
+
+export default drawChart;

package/src/charts/bars/frac-grouped.js

@@ -7,6 +7,13 @@ import drawGroupedChart from './draw-grouped.js';
 // data = [datum]
 // datum = {value, colorState, symbol, state}
 
+/** Draws a single grouped bar row using fractional width block characters.
+ * @param {object[]} data - Normalized data series.
+ * @param {number} width - Total width.
+ * @param {number} maxValue - Maximum value for scaling.
+ * @param {object} [options] - Options including `reverse`, `rectSize`, `initState`.
+ * @returns {string[]} The drawn row lines.
+ */
 export const drawRow = (data, width, maxValue, options = {}) => {
   const {reverse, rectSize = 1, initState = {}} = options,
     blocks = data.map(datum => {
@@ -28,6 +35,12 @@ export const drawRow = (data, width, maxValue, options = {}) => {
   return result.map(line => optimize(line));
 };
 
+/** Draws a complete fractional grouped bar chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available width.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawGroupedChart(drawRow);
 
 export default drawChart;

package/src/charts/bars/plain-grouped.d.ts

@@ -0,0 +1,12 @@
+import {ChartDataInput} from '../utils.js';
+import {GroupedChartOptions} from './draw-grouped.js';
+
+/** Draws a complete plain grouped bar chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: GroupedChartOptions): string[];
+
+export default drawChart;

package/src/charts/bars/plain-grouped.js

@@ -1,6 +1,12 @@
 import {drawRow} from './plain.js';
 import drawGroupedChart from './draw-grouped.js';
 
+/** Draws a complete plain grouped bar chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available width.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawGroupedChart(drawRow);
 
 export default drawChart;

package/src/charts/bars/plain.d.ts

@@ -0,0 +1,75 @@
+import {ChartDatum, ChartDataInput, DrawItemInfo} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+import {StackedChartOptions} from './draw-stacked.js';
+
+/** Options for plain bar charts. */
+export interface PlainBarOptions extends StackedChartOptions {
+  /** Custom draw function for a single bar item.
+   * @param datum - The chart data item or null.
+   * @param size - Allocated size in characters.
+   * @param info - Drawing info.
+   * @param options - Options.
+   * @returns The drawn string.
+   */
+  drawItem?: (datum: ChartDatum | null, size: number, info: DrawItemInfo, options: PlainBarOptions) => string;
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+}
+
+/** Default draw function for a single bar item.
+ * @param datum - The chart data item.
+ * @param size - Allocated size.
+ * @param info - Drawing info.
+ * @param options - Options.
+ * @returns The drawn string.
+ */
+export function defaultDrawItem(datum: ChartDatum | null, size: number, info: DrawItemInfo, options: PlainBarOptions): string;
+
+/** Options for `drawItemLabel()`. */
+export interface DrawItemLabelOptions {
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+  /** If true, truncate the label to fit. */
+  truncate?: boolean;
+  /** If true, use ellipsis when truncating. */
+  useEllipsis?: boolean;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+}
+
+/** Draws a bar item with a text label.
+ * @param datum - The chart data item.
+ * @param size - Allocated size.
+ * @param info - Drawing info.
+ * @param options - Label options.
+ * @returns The drawn string.
+ */
+export function drawItemLabel(datum: ChartDatum | null, size: number, info: DrawItemInfo, options: DrawItemLabelOptions): string;
+
+/** Draws a single stacked bar row.
+ * @param data - Array of chart data items.
+ * @param width - Available width.
+ * @param maxValue - Maximum value for scaling.
+ * @param options - Bar options.
+ * @returns The drawn row as a string or string array.
+ */
+export function drawRow(
+  data: ChartDatum[],
+  width: number,
+  maxValue: number,
+  options?: PlainBarOptions
+): string | string[];
+
+/** Draws a complete plain stacked bar chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Bar options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: PlainBarOptions): string[];
+
+export default drawChart;

package/src/charts/bars/plain.js

@@ -10,6 +10,13 @@ import defaultTheme from '../themes/default.js';
 
 const defaultSymbol = vBlocks8th[7];
 
+/** Default draw function for a single bar item.
+ * @param {object} datum - Data item with `value`, `colorState`, `symbol`, `state`.
+ * @param {number} size - Allocated size in characters.
+ * @param {object} _ - Context (index, data, sizes, etc.).
+ * @param {object} options - Draw options.
+ * @returns {string} Styled string.
+ */
 export const defaultDrawItem = (datum, size, _, {initState = {}}) =>
   datum
     ? style
@@ -19,6 +26,13 @@ export const defaultDrawItem = (datum, size, _, {initState = {}}) =>
         .text((datum.symbol || defaultSymbol).repeat(size))
     : '';
 
+/** Draws a bar item with a text label instead of a filled symbol.
+ * @param {object} datum - Data item with `label`, `symbol`, `colorState`, `state`.
+ * @param {number} size - Allocated size.
+ * @param {object} _ - Context.
+ * @param {object} options - Draw options including `reverse`, `truncate`, `useEllipsis`.
+ * @returns {string} Styled string.
+ */
 export const drawItemLabel = (datum, size, _, {reverse, truncate, useEllipsis = true, initState = {}}) => {
   if (!datum) return '';
   const symbol = datum.symbol || ' ';
@@ -37,6 +51,13 @@ export const drawItemLabel = (datum, size, _, {reverse, truncate, useEllipsis =
     .text(label);
 };
 
+/** Draws a single stacked bar row.
+ * @param {object[]} data - Normalized data series.
+ * @param {number} width - Total width.
+ * @param {number} maxValue - Maximum value for scaling.
+ * @param {object} [options] - Options including `drawItem`, `rectSize`, `theme`, `initState`, `reverse`.
+ * @returns {string|string[]} The drawn row(s).
+ */
 export const drawRow = (data, width, maxValue, options = {}) => {
   const {drawItem = defaultDrawItem, rectSize = 0, theme = defaultTheme, initState, reverse} = options,
     {symbol = ' ', state = null, colorState} = theme?.empty || {},
@@ -58,6 +79,12 @@ export const drawRow = (data, width, maxValue, options = {}) => {
   return new Array(rectSize).fill(row);
 };
 
+/** Draws a complete plain stacked bar chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available width.
+ * @param {object} [options] - Bar options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawStackedChart(drawRow);
 
 export default drawChart;

package/src/charts/columns/block-frac-grouped.d.ts

@@ -0,0 +1,12 @@
+import {ChartDataInput} from '../utils.js';
+import {GroupedColumnChartOptions} from './draw-grouped.js';
+
+/** Draws a complete fractional block grouped column chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: GroupedColumnChartOptions): string[];
+
+export default drawChart;

package/src/charts/columns/block-frac-grouped.js

@@ -1,6 +1,12 @@
 import {drawColumn} from './block-frac.js';
 import drawGroupedChart from './draw-grouped.js';
 
+/** Draws a complete fractional block grouped column chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available height.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawGroupedChart(drawColumn);
 
 export default drawChart;

package/src/charts/columns/block-frac.d.ts

@@ -0,0 +1,39 @@
+import {ChartDatum, ChartDataInput} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+import {StackedColumnChartOptions} from './draw-stacked.js';
+
+/** Options for fractional block column charts. */
+export interface BlockFracColumnOptions extends StackedColumnChartOptions {
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+  /** If true, draw an empty border when fractional part is 0. */
+  drawEmptyBorder?: boolean;
+}
+
+/** Draws a single stacked column using fractional block characters.
+ * @param data - Chart data items.
+ * @param width - Available width.
+ * @param maxValue - Maximum value.
+ * @param options - Options.
+ * @returns Array of strings for the column.
+ */
+export function drawColumn(
+  data: ChartDatum[],
+  width: number,
+  maxValue: number,
+  options?: BlockFracColumnOptions
+): string[];
+
+/** Draws a complete fractional block stacked column chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: BlockFracColumnOptions): string[];
+
+export default drawChart;

package/src/charts/columns/block-frac.js

@@ -8,6 +8,13 @@ import {drawRealWidthBlock} from '../../draw-block-frac.js';
 // data = [datum]
 // datum = {value, colorState, symbol, state}
 
+/** Draws a single stacked column using fractional block characters.
+ * @param {object[]} data - Normalized data series.
+ * @param {number} width - Total height.
+ * @param {number} maxValue - Maximum value for scaling.
+ * @param {object} [options] - Options including `reverse`, `drawEmptyBorder`, `rectSize`, `initState`.
+ * @returns {string[]} The drawn column lines.
+ */
 export const drawColumn = (data, width, maxValue, options = {}) => {
   const {reverse, drawEmptyBorder, initState} = options,
     rectSize = Math.max(0, options.rectSize ?? 0.5),
@@ -25,6 +32,12 @@ export const drawColumn = (data, width, maxValue, options = {}) => {
   return result.map(line => optimize(line));
 };
 
+/** Draws a complete fractional block stacked column chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available height.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawStackedChart(drawColumn);
 
 export default drawChart;

package/src/charts/columns/block-grouped.d.ts

@@ -0,0 +1,12 @@
+import {ChartDataInput} from '../utils.js';
+import {GroupedColumnChartOptions} from './draw-grouped.js';
+
+/** Draws a complete block grouped column chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: GroupedColumnChartOptions): string[];
+
+export default drawChart;

package/src/charts/columns/block-grouped.js

@@ -1,6 +1,12 @@
 import {drawColumn} from './block.js';
 import drawGroupedChart from './draw-grouped.js';
 
+/** Draws a complete block grouped column chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available height.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawGroupedChart(drawColumn);
 
 export default drawChart;

package/src/charts/columns/block.d.ts

@@ -0,0 +1,43 @@
+import {ChartDatum, ChartDataInput} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+import {LineTheme} from '../../themes/utils.js';
+import {StackedColumnChartOptions} from './draw-stacked.js';
+
+/** Options for block column charts. */
+export interface BlockColumnOptions extends StackedColumnChartOptions {
+  /** Block theme for drawing. */
+  blockTheme?: LineTheme;
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+  /** If set, draw the top border. */
+  t?: number;
+  /** If set, draw the bottom border. */
+  b?: number;
+  /** If set, draw the left border. */
+  l?: number;
+  /** If set, draw the right border. */
+  r?: number;
+}
+
+/** Draws a single stacked column using block-drawing characters.
+ * @param data - Chart data items.
+ * @param width - Available width.
+ * @param maxValue - Maximum value.
+ * @param options - Options.
+ * @returns Array of strings for the column.
+ */
+export function drawColumn(data: ChartDatum[], width: number, maxValue: number, options?: BlockColumnOptions): string[];
+
+/** Draws a complete block stacked column chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: BlockColumnOptions): string[];
+
+export default drawChart;

package/src/charts/columns/block.js

@@ -9,6 +9,13 @@ import defaultBlockTheme from '../../themes/blocks/unicode-half.js';
 // data = [datum]
 // datum = {value, colorState, symbol, state}
 
+/** Draws a single stacked column using block-drawing characters.
+ * @param {object[]} data - Normalized data series.
+ * @param {number} width - Total height.
+ * @param {number} maxValue - Maximum value for scaling.
+ * @param {object} [options] - Options including `reverse`, `blockTheme`, `rectSize`, `initState`.
+ * @returns {string[]} The drawn column lines.
+ */
 export const drawColumn = (data, width, maxValue, options = {}) => {
   const {reverse, blockTheme = defaultBlockTheme, rectSize = 0, initState = {}} = options,
     sizes = allocateSizes(data, maxValue, width),
@@ -32,6 +39,12 @@ export const drawColumn = (data, width, maxValue, options = {}) => {
   return result.map(line => optimize(line));
 };
 
+/** Draws a complete block stacked column chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available height.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawStackedChart(drawColumn);
 
 export default drawChart;

package/src/charts/columns/draw-grouped.d.ts

@@ -0,0 +1,41 @@
+import {ChartDatum, ChartDataInput, ChartTheme} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+
+/** Options for grouped column charts. */
+export interface GroupedColumnChartOptions {
+  /** Maximum value for scaling (default: auto). */
+  maxValue?: number;
+  /** Gap between groups in characters. */
+  groupGap?: number;
+  /** Gap between items within a group. */
+  gap?: number;
+  /** Chart theme. */
+  theme?: ChartTheme;
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+  /** Additional custom options. */
+  [key: string]: unknown;
+}
+
+/** Function that draws a single column of a chart.
+ * @param data - Array of chart data items.
+ * @param width - Available width in characters.
+ * @param maxValue - Maximum value for scaling.
+ * @param options - Optional chart options.
+ * @returns Array of strings for the column.
+ */
+type DrawColumnFn = (data: ChartDatum[], width: number, maxValue: number, options?: GroupedColumnChartOptions) => string[];
+
+/** Creates a grouped column chart drawing function from a column-drawing function.
+ * @param drawColumn - The column-drawing function.
+ * @returns A chart-drawing function.
+ */
+export function drawChart(
+  drawColumn: DrawColumnFn
+): (values: ChartDataInput, width: number, options?: GroupedColumnChartOptions) => string[];
+
+export default drawChart;

package/src/charts/columns/draw-grouped.js

@@ -3,6 +3,10 @@ import {normalizeData} from '../utils.js';
 import Panel from '../../panel.js';
 import style from '../../style.js';
 
+/** Creates a grouped column chart drawing function from a column-drawing function.
+ * @param {Function} drawColumn - Function `(data, width, maxValue, options) => string[]`.
+ * @returns {Function} Chart drawing function `(values, width, options) => string[]`.
+ */
 export const drawChart =
   drawColumn =>
   (values, width, options = {}) => {

package/src/charts/columns/draw-stacked.d.ts

@@ -0,0 +1,39 @@
+import {ChartDatum, ChartDataInput, ChartTheme} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+
+/** Options for stacked column charts. */
+export interface StackedColumnChartOptions {
+  /** Maximum value for scaling (default: auto). */
+  maxValue?: number;
+  /** Gap between columns in characters. */
+  gap?: number;
+  /** Chart theme. */
+  theme?: ChartTheme;
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+  /** Additional custom options. */
+  [key: string]: unknown;
+}
+
+/** Function that draws a single column of a chart.
+ * @param data - Array of chart data items.
+ * @param width - Available width in characters.
+ * @param maxValue - Maximum value for scaling.
+ * @param options - Optional chart options.
+ * @returns Array of strings for the column.
+ */
+type DrawColumnFn = (data: ChartDatum[], width: number, maxValue: number, options?: StackedColumnChartOptions) => string[];
+
+/** Creates a stacked column chart drawing function from a column-drawing function.
+ * @param drawColumn - The column-drawing function.
+ * @returns A chart-drawing function.
+ */
+export function drawChart(
+  drawColumn: DrawColumnFn
+): (values: ChartDataInput, width: number, options?: StackedColumnChartOptions) => string[];
+
+export default drawChart;

package/src/charts/columns/draw-stacked.js

@@ -3,6 +3,10 @@ import {normalizeData, sumValues} from '../utils.js';
 import Panel from '../../panel.js';
 import style from '../../style.js';
 
+/** Creates a stacked column chart drawing function from a column-drawing function.
+ * @param {Function} drawColumn - Function `(data, width, maxValue, options) => string[]`.
+ * @returns {Function} Chart drawing function `(values, width, options) => string[]`.
+ */
 export const drawChart =
   drawColumn =>
   (values, width, options = {}) => {

package/src/charts/columns/frac-grouped.d.ts

@@ -0,0 +1,37 @@
+import {ChartDatum, ChartDataInput} from '../utils.js';
+import {SgrState} from '../../ansi/sgr-state.js';
+import {GroupedColumnChartOptions} from './draw-grouped.js';
+
+/** Options for fractional grouped column charts. */
+export interface FracGroupedColumnOptions extends GroupedColumnChartOptions {
+  /** Size of each rectangle in characters. */
+  rectSize?: number;
+  /** Initial SGR state. */
+  initState?: SgrState | string | null;
+  /** If true, reverse the drawing direction. */
+  reverse?: boolean;
+}
+
+/** Draws a single grouped column using fractional height block characters.
+ * @param data - Chart data items.
+ * @param width - Available width.
+ * @param maxValue - Maximum value.
+ * @param options - Options.
+ * @returns Array of strings for the column.
+ */
+export function drawColumn(
+  data: ChartDatum[],
+  width: number,
+  maxValue: number,
+  options?: FracGroupedColumnOptions
+): string[];
+
+/** Draws a complete fractional grouped column chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: FracGroupedColumnOptions): string[];
+
+export default drawChart;

package/src/charts/columns/frac-grouped.js

@@ -7,6 +7,13 @@ import drawGroupedChart from './draw-grouped.js';
 // data = [datum]
 // datum = {value, colorState, symbol, state}
 
+/** Draws a single grouped column using fractional height block characters.
+ * @param {object[]} data - Normalized data series.
+ * @param {number} width - Total height.
+ * @param {number} maxValue - Maximum value for scaling.
+ * @param {object} [options] - Options including `reverse`, `rectSize`, `initState`.
+ * @returns {string[]} The drawn column lines.
+ */
 export const drawColumn = (data, width, maxValue, options = {}) => {
   const {reverse, rectSize = 1, initState = {}} = options,
     blocks = data.map(datum => {
@@ -22,6 +29,12 @@ export const drawColumn = (data, width, maxValue, options = {}) => {
   return result.map(line => optimize(line));
 };
 
+/** Draws a complete fractional grouped column chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available height.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawGroupedChart(drawColumn);
 
 export default drawChart;

package/src/charts/columns/plain-grouped.d.ts

@@ -0,0 +1,12 @@
+import {ChartDataInput} from '../utils.js';
+import {GroupedColumnChartOptions} from './draw-grouped.js';
+
+/** Draws a complete plain grouped column chart.
+ * @param values - Chart data.
+ * @param width - Available width.
+ * @param options - Options.
+ * @returns Array of strings representing the chart.
+ */
+export function drawChart(values: ChartDataInput, width: number, options?: GroupedColumnChartOptions): string[];
+
+export default drawChart;

package/src/charts/columns/plain-grouped.js

@@ -1,6 +1,12 @@
 import {drawColumn} from './plain.js';
 import drawGroupedChart from './draw-grouped.js';
 
+/** Draws a complete plain grouped column chart.
+ * @param {any[]} values - Chart data.
+ * @param {number} width - Available height.
+ * @param {object} [options] - Options.
+ * @returns {string[]} Array of strings representing the chart.
+ */
 export const drawChart = drawGroupedChart(drawColumn);
 
 export default drawChart;