feat: add arrayIndexesAsKeys option support for #207

mrodrig · Feb 25, 2024 · feeec3b · feeec3b
1 parent 6fccca0
commit feeec3b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/src/constants.ts b/src/constants.ts
@@ -18,6 +18,7 @@ export const errors = {
 };
 
 export const defaultJson2CsvOptions: DefaultJson2CsvOptions = {
+    arrayIndexesAsKeys: false,
     checkSchemaDifferences: false,
     delimiter : {
         field : ',',

diff --git a/src/json2csv.ts b/src/json2csv.ts
@@ -12,6 +12,7 @@ export const Json2Csv = function(options: FullJson2CsvOptions) {
         customValueParser = options.parseValue && typeof options.parseValue === 'function' ? options.parseValue : null,
         expandingWithoutUnwinding = options.expandArrayObjects && !options.unwindArrays,
         deeksOptions = {
+            arrayIndexesAsKeys: options.arrayIndexesAsKeys,
             expandNestedObjects: options.expandNestedObjects,
             expandArrayObjects: expandingWithoutUnwinding,
             ignoreEmptyArraysWhenExpanding: expandingWithoutUnwinding,

diff --git a/src/types.ts b/src/types.ts
@@ -87,6 +87,11 @@ export interface Csv2JsonOptions extends Omit<SharedConverterOptions, 'keys'> {
 }
 
 export interface Json2CsvOptions extends SharedConverterOptions {
+  /** Should array indexes be included in the generated keys?
+   * @default false
+   */
+  arrayIndexesAsKeys?: boolean;
+
   /**
    * Should all documents have the same schema?
    * @default false