From 02006d2c84a9df7ed41d7bea16da73fe2eaab0a4 Mon Sep 17 00:00:00 2001 From: Coston Perkins Date: Wed, 2 Oct 2024 09:26:07 -0500 Subject: [PATCH] docs: update properties --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c25b83b..6f893bc 100644 --- a/README.md +++ b/README.md @@ -105,12 +105,9 @@ or load from a CDN: Download Data ); - }; +}; ``` - - - ## Properties ```typescript @@ -120,13 +117,12 @@ interface HeaderMapping { } ``` - -| # | Property | Type | Requirement | Default | Description | -| - | --------- | -------------------------------- | ----------- | ------------------------- | ---------------------------------------------------------------------------------------- | -| 1 | data | [] | required | | array of objects | -| 2 | filename | string | optional | "export.csv" | The filename. The .csv extention will be added if not included in file name | -| 3 | delimiter | string | optional | "," | fields separator | -| 4 | headers | string[] OR
HeaderMapping[] | optional | provided data object keys | List of columns that will be used in the final CSV file. Recommended for large datasets! | +| # | Property | Type | Requirement | Default | Description | +| --- | --------- | ----------------------------- | ----------- | ------------ | --------------------------------------------------------------------------- | +| 1 | data | `Record[]` | required | | array of objects | +| 2 | filename | `string` | optional | "export.csv" | The filename. The .csv extention will be added if not included in file name | +| 3 | delimiter | `string` | optional | "," | fields separator | +| 4 | headers | `string[]`, `HeaderMapping[]` | optional | | provided data object keys | ## Migration from version 1.x to 2.x