cdk-table-exporter - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "cdk-table-exporter",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "author": "Halit Talha Türe",
   "license": "Apache-2.0",
-  "licenses": [
-    {
-      "type": "Apache-2.0",
-      "url": "http://www.apache.org/licenses/LICENSE-2.0"
-    }
-  ],
+  "repository": {
+    "type": "git",
+	"url": "https://github.com/HalitTalha/cdk-table-exporter"
+  },
   "peerDependencies": {
@@ -20,3 +18,21 @@ "@angular/common": "^7.2.0",
     "@angular/cdk": "~7.3.5"
-  }
+  },
+  "scripts": {
+    "lint": "node_modules/.bin/goodparts lib"
+  },
+  "devDependencies": {
+    "goodparts": "^1.2.1"
+  },
+  "keywords": [
+    "cdktable",
+    "angular",
+    "material",
+    "mattable",
+    "table",
+    "export",
+    "table export",
+    "paginated",
+    "table export",
+    "excel export"
+  ]
 }

README.md

@@ -1,4 +0,5 @@
-# Angular Table Exporter
+[![JavaScript Style Guide: Good Parts](https://img.shields.io/badge/code%20style-goodparts-brightgreen.svg?style=flat)](https://github.com/dwyl/goodparts "JavaScript The Good Parts")  [![Node version](https://img.shields.io/npm/v/cdk-table-exporter.svg?style=flat)](https://www.npmjs.com/package/cdk-table-exporter)
+# Angular Table Exporter (CdkTable Exporter)
 
-This project is mainly for making CdkTable components exportable as excel files. cdk-table-exporter facilitates the common functionalities for CdkTable implementations abstracting the behavior that can change among different CdkTable implementations, mat-table-exporter is a cdk-table-exporter subtype and provides support for angular material's cdkTable which is MatTable.
+This project is mainly for making CdkTable components exportable as excel files. cdk-table-exporter facilitates the common functionalities for CdkTable implementations abstracting the behavior that can change among different CdkTable implementations, see [mat-table-exporter](https://www.npmjs.com/package/mat-table-exporter) for angular material table export.
 
@@ -12,3 +13,3 @@ ## Getting Started
 ```
-After installing mat-table-exporter import MatTableExporterModule in your ngModules
+After installing cdk-table-exporter import CdkTableExporterModule in your ngModules
 
@@ -21,16 +22,18 @@ You can find more detail under the corresponding title of Usage section
 
-##API
 
+## API
+
 ### CdkTableExporter
 
-| Input/Output | Type | Description |
-| --- | --- | --- |
-| @Input | cdkTable | any | Template-referance of CdkTable that's to be exported |
-| @Input | exporterButton | any | Template-referance of the button that's used to trigger the export |
-| @Input | sheetName | string | Template-referance of CdkTable that's to be exported |
-| @Input | fileName | string | Template-referance of CdkTable that's to be exported |
-| @Input | hiddenColumns | Array<number> | The indexes of the columns that are not wanted in the excel file |
-| @Output | exportStarted | EventEmitter<void> | Event that's fired when the export started |
-| @Output | exportCompleted | EventEmitter<void> | Event that's fired when the export completed |
+| Input/Output | Property | Type | Description |
+| --- | --- | --- | --- |
+| `@Input` | cdkTable | `any` | Template-referance of CdkTable that's to be exported |
+| `@Input` | exporterButton | `any` | Template-referance of the button that's used to trigger the export |
+| `@Input` | sheetName | `string` | Template-referance of CdkTable that's to be exported |
+| `@Input` | fileName | `string` | Template-referance of CdkTable that's to be exported |
+| `@Input` | hiddenColumns | `Array<number>` | The indexes of the columns that are not wanted in the excel file |
+| `@Output` | exportStarted | `EventEmitter<void>` | Event that's fired when the export started |
+| `@Output` | exportCompleted | `EventEmitter<void>` | Event that's fired when the export completed |
 
+
 ### JsonExporterService
@@ -46,7 +49,7 @@
 | --- | --- | --- |
-| header | any | Any json object that holds the header information of the exported excel file aka the first row of the excel |
-| rows | Array<any> | Any json array that will be the rows of the exported excel | 
-| fileName | string | Exported excel file's name | 
-| sheetName | string | The name of the sheet that keeps the exported data | 
-| hiddenColumns | Array<string> | Properties that are wanted to be hidden, i.e. id, createdDate, auditable properties etc. | 
+| header | `any` | Any json object that holds the header information of the exported excel file aka the first row of the excel |
+| rows | `Array<any>` | Any json array that will be the rows of the exported excel | 
+| fileName | `string` | Exported excel file's name | 
+| sheetName | `string` | The name of the sheet that keeps the exported data | 
+| hiddenColumns | `Array<string>` | Properties that are wanted to be hidden, i.e. id, createdDate, auditable properties etc. | 
 
@@ -53,0 +56,0 @@

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25942

increased by86.86%

Number of package files

14

increased by16.67%

Number of lines in readme file

57

increased by5.56%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes