From 59538ee78f1f01a94c98e557136720d7a15d7143 Mon Sep 17 00:00:00 2001
From: Michael Marziani <mmarziani@gmail.com>
Date: Tue, 18 Jan 2022 19:05:40 +0100
Subject: [PATCH] Extract SheetOption interface
Have WritingOptions and Table2SheetOpts inherit. Fixes TS error setting
sheet name when using table_to_book and other table_to functions.
---
types/index.d.ts | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/types/index.d.ts b/types/index.d.ts
index f4a0588..080de11 100644
--- a/types/index.d.ts
+++ b/types/index.d.ts
@@ -205,8 +205,16 @@ export interface ParsingOptions extends CommonOptions {
dense?: boolean;
}
+export interface SheetOption {
+ /**
+ * Name of Worksheet (for single-sheet formats)
+ * @default ''
+ */
+ sheet?: string;
+}
+
/** Options for write and writeFile */
-export interface WritingOptions extends CommonOptions {
+export interface WritingOptions extends CommonOptions, SheetOption {
/** Output data encoding */
type?: 'base64' | 'binary' | 'buffer' | 'file' | 'array' | 'string';
@@ -222,12 +230,6 @@ export interface WritingOptions extends CommonOptions {
*/
bookType?: BookType;
- /**
- * Name of Worksheet (for single-sheet formats)
- * @default ''
- */
- sheet?: string;
-
/**
* Use ZIP compression for ZIP-based formats
* @default false
@@ -702,7 +704,7 @@ export interface JSON2SheetOpts extends CommonOptions, DateNFOption {
export interface SheetJSONOpts extends JSON2SheetOpts, OriginOption {}
-export interface Table2SheetOpts extends CommonOptions, DateNFOption, OriginOption {
+export interface Table2SheetOpts extends CommonOptions, DateNFOption, OriginOption, SheetOption {
/** If true, plaintext parsing will not parse values */
raw?: boolean;