@uttori/data-tools/dist/data-formating.d.ts

Tools for working with binary data.

export function formatBytes(input: number, decimals?: number, bytes?: number, sizes?: string[]): string;
export function formatASCII(value: number, asciiFlags: Record<string, boolean | number | string>, _data: DataBuffer | DataStream): import("../dist/custom.js").FormatASCIIOutput;
/**
 * Formatting functions for all value types.
 * @typedef {object} HexTableFormater
 * @property {import('../dist/custom.js').FormatNumber} offset Offset formatting fuction.
 * @property {import('../dist/custom.js').FormatNumber} value Byte value formating function.
 * @property {import('../dist/custom.js').FormatNumberToASCII} ascii ASCII text formatting function.
 */
/**
 * @type {import('../dist/custom.js').HexTableFormater}
 */
export const hexTableFormaters: import("../dist/custom.js").HexTableFormater;
/**
 * Header layout definitions.
 * GNU poke hexTableHeader.value = ['00', '11', '22', '33', '44', '55', '66', '77', '88', '99', 'aa', 'bb', 'cc', 'dd', 'ee', 'ff']
 * @typedef {object} HexTableHeader
 * @property {string} offset Offset header column presentation.
 * @property {string[]} value Byte value header values, grouped as defined in the provided HexTableDimensions.
 * @property {string} ascii ASCII text presentation.
 */
/**
 * @type {HexTableHeader}
 */
export const hexTableHeader: HexTableHeader;
/**
 * Header layout definitions.
 * @typedef {object} HexTableDimensions
 * @property {number} columns The number of columns to show in the byte value section of the table.
 * @property {number} grouping The number of bytes to cluster together in the byte value section of the table.
 * @property {number} maxRows The maxiumum number of rows to show excluding the header & seperator rows.
 */
/**
 * @type {HexTableDimensions}
 */
export const hexTableDimensions: HexTableDimensions;
export function hexTable(input: DataBuffer | DataStream, offset?: number, dimensions?: HexTableDimensions, header?: HexTableHeader, format?: HexTableFormater): string;
export function formatTableLine(columnLengths: number[], type: string, options: {
    theme: TableFormatStyle;
    padding: number;
}): string;
/**
 * Table Format Style definitions.
 * @typedef {object} TableFormatStyle
 * @property {boolean} topRow If true, show the top frame, if false, hide the top frame. Typically used for full framed styles.
 * @property {boolean} bottomRow If true, show the bottom frame, if false, hide the top frame. Typically used for full framed styles.
 * @property {string} upperLeft Top Left Character
 * @property {string} upperRight Top Right Chcaracter
 * @property {string} lowerLeft Bottom Left Character
 * @property {string} lowerRight Bottom Right Character
 * @property {string} intersection 4 Way Intersection Character
 * @property {string} line Horizontal Line Character
 * @property {string} wall Vertical Line Character
 * @property {string} intersectionTop 2 Way Intersection from the bottom Character
 * @property {string} intersectionBottom 2 Way Intersection from the top Character
 * @property {string} intersectionLeft 2 Way Intersection from the right Character
 * @property {string} intersectionRight 2 Way Intersection from the left Character
 */
/**
 * MySQL Style Table Layout
 * @type {TableFormatStyle}
 */
export const formatTableThemeMySQL: TableFormatStyle;
/**
 * Unicode Table Layout
 * @type {TableFormatStyle}
 */
export const formatTableThemeUnicode: TableFormatStyle;
/**
 * Markdown Table Layout
 * @type {TableFormatStyle}
 */
export const formatTableThemeMarkdown: TableFormatStyle;
export function formatTable(data: string[][], options: {
    align: string[];
    padding: number;
    theme: TableFormatStyle;
    title: string;
}): string;
declare namespace _default {
    export { formatBytes };
    export { formatASCII };
    export { hexTable };
    export { hexTableDimensions };
    export { hexTableHeader };
    export { hexTableFormaters };
    export { formatTable };
    export { formatTableThemeMySQL };
    export { formatTableThemeUnicode };
    export { formatTableThemeMarkdown };
}
export default _default;
/**
 * Formatting functions for all value types.
 */
export type HexTableFormater = {
    /**
     * Offset formatting fuction.
     */
    offset: import("../dist/custom.js").FormatNumber;
    /**
     * Byte value formating function.
     */
    value: import("../dist/custom.js").FormatNumber;
    /**
     * ASCII text formatting function.
     */
    ascii: import("../dist/custom.js").FormatNumberToASCII;
};
/**
 * Header layout definitions.
 * GNU poke hexTableHeader.value = ['00', '11', '22', '33', '44', '55', '66', '77', '88', '99', 'aa', 'bb', 'cc', 'dd', 'ee', 'ff']
 */
export type HexTableHeader = {
    /**
     * Offset header column presentation.
     */
    offset: string;
    /**
     * Byte value header values, grouped as defined in the provided HexTableDimensions.
     */
    value: string[];
    /**
     * ASCII text presentation.
     */
    ascii: string;
};
/**
 * Header layout definitions.
 */
export type HexTableDimensions = {
    /**
     * The number of columns to show in the byte value section of the table.
     */
    columns: number;
    /**
     * The number of bytes to cluster together in the byte value section of the table.
     */
    grouping: number;
    /**
     * The maxiumum number of rows to show excluding the header & seperator rows.
     */
    maxRows: number;
};
/**
 * Table Format Style definitions.
 */
export type TableFormatStyle = {
    /**
     * If true, show the top frame, if false, hide the top frame. Typically used for full framed styles.
     */
    topRow: boolean;
    /**
     * If true, show the bottom frame, if false, hide the top frame. Typically used for full framed styles.
     */
    bottomRow: boolean;
    /**
     * Top Left Character
     */
    upperLeft: string;
    /**
     * Top Right Chcaracter
     */
    upperRight: string;
    /**
     * Bottom Left Character
     */
    lowerLeft: string;
    /**
     * Bottom Right Character
     */
    lowerRight: string;
    /**
     * 4 Way Intersection Character
     */
    intersection: string;
    /**
     * Horizontal Line Character
     */
    line: string;
    /**
     * Vertical Line Character
     */
    wall: string;
    /**
     * 2 Way Intersection from the bottom Character
     */
    intersectionTop: string;
    /**
     * 2 Way Intersection from the top Character
     */
    intersectionBottom: string;
    /**
     * 2 Way Intersection from the right Character
     */
    intersectionLeft: string;
    /**
     * 2 Way Intersection from the left Character
     */
    intersectionRight: string;
};
import DataBuffer from './data-buffer.js';
import DataStream from './data-stream.js';
//# sourceMappingURL=data-formating.d.ts.map