DefinitelyTyped/types/zipcelx/index.d.ts

// Type definitions for zipcelx 1.5
// Project: https://github.com/dixieio/zipcelx#readme
// Definitions by: Alessandro Burato <https://github.com/aleburato>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * The value and type of a single cell. Only strings and numbers are supported.
 */
export interface ZipCelXCell {
    /**
     * The cell value
     */
    value: string | number;
    /**
     * The cell value type
     */
    type: "string" | "number";
}

/**
 * A Row (a set of cells)
 */
export type ZipCelXRow = ZipCelXCell[];

/**
 * A DataSet (a set of rows)
 */
export type ZipCelXDataSet = ZipCelXRow[];

/**
 * Represents a Sheet
 */
export interface ZipCelXSheet {
    /**
     * The sheet's DataSet
     */
    data: ZipCelXDataSet;
}

/**
 * The zipcelx configuration
 */
export interface ZipCelXConfig {
    /**
     * The file name of the exported file
     */
    filename: string;

    /**
     * The sheet to be exported as an .xlsx file
     */
    sheet: ZipCelXSheet;
}

export default function zipcelx(config: ZipCelXConfig): Promise<Blob>;