![\"CSV](\"./.github/images/csv-parser-logo.png\"){kind=logo}
\n \n\n \n \n \n \n\n
\n A lib to serialize CSV files into JSON objects.\n
\n\n\n# Overview\n\n- [Usage](#usage)\n - [handleInputChange](#handleInputChange)\n - [loadContent](#loadContent)\n - [toJson](#toJson)\n - [validateFields](#validateFields)\n \n \n- [License](#memo-license)\n\n# Usage\n\nImport the files, that you can find on `build/`, in your page, then you will be able to invoke `CSV`. It contains three methods you can use to handle your CSV files on browser\n\n## **handleInputChange**\n\nIt's basically what you need to add on change event of your input element and it will return you the serialized file, it's not necessary to check if the input have files, but if you do not do it, the promise will be reject, so just treat the exception.\n\n**Parameters**\n\n```typescript\ninterface IParams {\n inputElement: HTMLInputElement;\n separator?: string; // default = ','\n}\n```\n\n**Return type**\n\nš Promise\n\nIf the file is in blank, You will receive `undefined`, but if the file has a valid content you will receive an object in the following format:\n\n```typescript\ninterface IResponse {\n filename: string;\n content: object[]; // the properties will follow the header found in this CSV file\n}\n```\n\n## **loadContent**\n\nThis function and the other one 'toJson' are just exported in case you wish to validate by yourself the content or anything else before serialize.\n\n**Parameters**\n\n```typescript\ninterface IParams {\n csvFile: Blob | File;\n}\n```\n\n**Return type**\n\nš Promise\n\nThis function returns the raw content as a string.\n\n## **toJson**\n\nThis function and the other one 'toJson' are just exported in case you wish to validate by yourself the content or anything else before serialize.\n\n**Parameters**\n\n**csvContent**: The raw content of a CSV file.\n\n```typescript\ninterface IParams {\n csvContent: string;\n separator?: string; // default = ','\n}\n```\n\n**Return type**\n\nThis function returns an object with the serialized CSV and also the next function, witch gives You the possibility to check the columns of the collection.\n\n```typescript\ninterface IResponse {\n serializedData: Array<{\n [key: string]: string | number;\n }>;\n validateFields: (\n expectedColumns: string[],\n ) => ValidateFields.IValidateFieldsResponse;\n}\n\n/* e.g:\n\nCorrect:\n [\n { id: 0, name: \"Jhon Doe\" },\n { id: 1, name: \"Jhon Roe\" }\n ]\n\nX Incorrect:\n [\n { 9001 : \"value\" }\n ]\n*/\n```\n\n## **validateFields**\n\nThis function validates if the serialized content has the specified fields.\n\n**Parameters**\n\n**csvContent**: The raw content of a CSV file.\n\n```typescript\ninterface IParams {\n expectedColumns: string[];\n data: Array<{\n [key: string]: string | number;\n }>;\n}\n```\n\n**Return type**\n\nThis function returns an object with the serialized CSV as the following:\n\n```typescript\ninterface IResponse {\n isValid: boolean;\n error: Error | null;\n data: Array<{\n [key: string]: string | number;\n }>;\n}\n```\n\n\n\n## :memo: License\n\nThis project is under license MIT. See the file [LICENSE](LICENSE) for more details.\n","readmeFilename":"README.md"}