@types/node-xlsx NPM

Installation

npm install --save @types/node-xlsx

Summary

This package contains type definitions for node-xlsx (https://github.com/mgcrea/node-xlsx#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-xlsx.

index.d.ts

// Type definitions for node-xlsx 0.15
// Project: https://github.com/mgcrea/node-xlsx#readme
// Definitions by: kinuxroot <https://github.com/kinuxroot>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0

/**
 * parsing a xlsx from file/buffer, outputs an object of worksheets
 * @param mixed file path or buffer
 * @param options options is for xlsx
 * @returns worksheets data, like: { name: 'worksheets', data: [[1,2,3],['1', '2','word']] }
 */
export function parse(
    mixed: string | ArrayBuffer,
    options?: {}
): Array<{
    name: string;
    data: unknown[][];
}>;

/**
 * building a xlsx
 * @param worksheets worksheets data, like:{ name: 'worksheets', data: [[1,2,3],['1', '2','word']] }
 * @param options spannig multiple rows A1:A4
 * @returns returns a buffer of worksheets
 */
export function build(
    worksheets: Array<{ name: string; data: any[][]; options?: {} | undefined }>,
    options?: {}
): ArrayBuffer;
declare const _default: {
    parse: typeof parse;
    build: typeof build;
};
export default _default;