{"id":26689407,"url":"https://github.com/muellerconstantin/qvd4js","last_synced_at":"2026-05-19T07:32:37.199Z","repository":{"id":215688895,"uuid":"739377926","full_name":"MuellerConstantin/qvd4js","owner":"MuellerConstantin","description":"Utility library for reading/writing Qlik View Data (QVD) files in JavaScript.","archived":false,"fork":false,"pushed_at":"2024-05-16T15:13:05.000Z","size":1449,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-07T07:00:33.934Z","etag":null,"topics":["babel","javascript","qlik","qlik-sense","qlik-view","qvd","qvd-data","qvd-files","qvd4js"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/qvd4js","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MuellerConstantin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-05T12:22:46.000Z","updated_at":"2025-02-19T17:16:19.000Z","dependencies_parsed_at":"2024-01-05T23:27:07.737Z","dependency_job_id":"d1ca21a8-ad56-4917-9d15-3b449d09ad24","html_url":"https://github.com/MuellerConstantin/qvd4js","commit_stats":null,"previous_names":["muellerconstantin/qvd4js"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/MuellerConstantin/qvd4js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuellerConstantin%2Fqvd4js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuellerConstantin%2Fqvd4js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuellerConstantin%2Fqvd4js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuellerConstantin%2Fqvd4js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MuellerConstantin","download_url":"https://codeload.github.com/MuellerConstantin/qvd4js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuellerConstantin%2Fqvd4js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33206320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-19T07:16:55.748Z","status":"ssl_error","status_checked_at":"2026-05-19T07:16:54.366Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","javascript","qlik","qlik-sense","qlik-view","qvd","qvd-data","qvd-files","qvd4js"],"created_at":"2025-03-26T14:35:26.129Z","updated_at":"2026-05-19T07:32:37.194Z","avatar_url":"https://github.com/MuellerConstantin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qvd4js\n\n\u003e Utility library for reading/writing Qlik View Data (QVD) files in JavaScript.\n\nThe _qvd4js_ library provides a simple API for reading/writing Qlik View Data (QVD) files in JavaScript. Using\nthis library, it is possible to parse the binary QVD file format and convert it to a JavaScript object\nstructure and vica versa. The library is written to be used in a Node.js environment exclusively.\n\n\u003e [!WARNING]\n\u003e qvd4js is not maintained any longer. For new projects, we recommend [qvdrs](https://github.com/bintocher/qvdrs).\n\n---\n\n- [Install](#install)\n- [Usage](#usage)\n- [QVD File Format](#qvd-file-format)\n  - [XML Header](#xml-header)\n  - [Symbol Table](#symbol-table)\n  - [Index Table](#index-table)\n- [API Documentation](#api-documentation)\n  - [QvdDataFrame](#qvddataframe)\n    - [`static fromQvd(path: string): Promise\u003cQvdDataFrame\u003e`](#static-fromqvdpath-string-promiseqvddataframe)\n    - [`static fromDict(dict: object): Promise\u003cQvdDataFrame\u003e`](#static-fromdictdict-object-promiseqvddataframe)\n    - [`head(n: number): QvdDataFrame`](#headn-number-qvddataframe)\n    - [`tail(n: number): QvdDataFrame`](#tailn-number-qvddataframe)\n    - [`rows(...args: number): QvdDataFrame`](#rowsargs-number-qvddataframe)\n    - [`at(row: number, column: string): any`](#atrow-number-column-string-any)\n    - [`select(...args: string): QvdDataFrame`](#selectargs-string-qvddataframe)\n    - [`toDict(): Promise\u003cobject\u003e`](#todict-promiseobject)\n    - [`toQvd(path: string): Promise\u003cvoid\u003e`](#toqvdpath-string-promisevoid)\n- [License](#license)\n  - [Forbidden](#forbidden)\n\n---\n\n## Install\n\n_qvd4js_ is a Node.js module available through [npm](https://www.npmjs.com/). The recommended way to install and maintain _qvd4js_ as a dependency is through the Node.js Package Manager (NPM).\nBefore installing this library, download and install Node.js.\n\nYou can get _qvd4js_ using the following command:\n\n```bash\nnpm install qvd4js --save\n```\n\n## Usage\n\nBelow is a quick example how to use _qvd4js_.\n\n```javascript\nimport {QvdDataFrame} from 'qvd4js';\n\nconst df = await QvdDataFrame.fromQvd('path/to/file.qvd');\nconsole.log(df.head(5));\n```\n\nThe above example loads the _qvd4js_ library and parses an example QVD file. A QVD file is typically loaded using the static\n`QvdDataFrame.fromQvd` function of the `QvdDataFrame` class itself. After loading the file's content, numerous methods and properties are available to work with the parsed data.\n\n## QVD File Format\n\nThe QVD file format is a binary file format that is used by QlikView to store data. The format is proprietary. However,\nthe format is well documented and can be parsed without the need of a QlikView installation. In fact, a QVD file consists\nof three parts: a XML header, and two binary parts, the symbol and the index table. The XML header contains meta information\nabout the QVD file, such as the number of data records and the names of the fields. The symbol table contains the actual\ndistinct values of the fields. The index table contains the actual data records. The index table is a list of indices\nwhich point to values in the symbol table.\n\n### XML Header\n\nThe XML header contains meta information about the QVD file. The header is always located at the beginning of the file and\nis in human readable text format. The header contains information about the number of data records, the names of the fields,\nand the data types of the fields.\n\n### Symbol Table\n\nThe symbol table contains the distinct/unique values of the fields and is located directly after the XML header. The order\nof columns in the symbol table corresponds to the order of the fields in the XML header. The length and offset of the\nsymbol sections of each column are also stored in the XML header. Each symbol section consist of the unique symbols of the\nrespective column. The type of a single symbol is determined by a type byte prefixed to the respective symbol value. The\nfollowing type of symbols are supported:\n\n| Code | Type         | Description                                                                                   |\n| ---- | ------------ | --------------------------------------------------------------------------------------------- |\n| 1    | Integer      | signed 4-byte integer (little endian)                                                         |\n| 2    | Float        | signed 8-byte IEEE floating point number (little endian)                                      |\n| 4    | String       | null terminated string                                                                        |\n| 5    | Dual Integer | signed 4-byte integer (little endian) followed by a null terminated string                    |\n| 6    | Dual Float   | signed 8-byte IEEE floating point number (little endian) followed by a null terminated string |\n\n### Index Table\n\nAfter the symbol table, the index table follows. The index table contains the actual data records. The index table contains\nbinary indices that refrences to the values of each row in the symbol table. The order of the columns in the index table\ncorresponds to the order of the fields in the XML header. Hence, the index table does not contain the actual values of a\ndata record, but only the indices that point to the values in the symbol table.\n\n## API Documentation\n\n### QvdDataFrame\n\nThe `QvdDataFrame` class represents the data frame stored inside of a finally parsed QVD file. It provides a high-level\nabstraction access to the QVD file content. This includes meta information as well as access to the actual data records.\n\n| Property  | Type       | Description                                                                                                        |\n| --------- | ---------- | ------------------------------------------------------------------------------------------------------------------ |\n| `shape`   | `number[]` | The shape of the data table. The first element is the number of rows, the second element is the number of columns. |\n| `data`    | `any[][]`  | The actual data records of the QVD file. The first dimension represents the single rows.                           |\n| `columns` | `string[]` | The names of the fields that are contained in the QVD file.                                                        |\n\n#### `static fromQvd(path: string): Promise\u003cQvdDataFrame\u003e`\n\nThe static method `QvdDataFrame.fromQvd` loads a QVD file from the given path and parses it. The method returns a promise that resolves\nto a `QvdDataFrame` instance.\n\n#### `static fromDict(dict: object): Promise\u003cQvdDataFrame\u003e`\n\nThe static method `QvdDataFrame.fromDict` constructs a data frame from a dictionary. The dictionary must contain the columns and\nthe actual data as properties. The columns property is an array of strings that contains the names of the fields in the QVD file.\nThe data property is an array of arrays that contains the actual data records. The order of the values in the inner arrays\ncorresponds to the order of the fields in the QVD file.\n\n#### `head(n: number): QvdDataFrame`\n\nThe method `head` returns the first `n` rows of the data frame.\n\n#### `tail(n: number): QvdDataFrame`\n\nThe method `tail` returns the last `n` rows of the data frame.\n\n#### `rows(...args: number): QvdDataFrame`\n\nThe method `rows` returns a new data frame that contains only the specified rows.\n\n#### `at(row: number, column: string): any`\n\nThe method `at` returns the value at the specified row and column.\n\n#### `select(...args: string): QvdDataFrame`\n\nThe method `select` returns a new data frame that contains only the specified columns.\n\n#### `toDict(): Promise\u003cobject\u003e`\n\nThe method `toDict` returns the data frame as a dictionary. The dictionary contains the columns and the\nactual data as properties. The columns property is an array of strings that contains the names of the\nfields in the QVD file. The data property is an array of arrays that contains the actual data records.\nThe order of the values in the inner arrays corresponds to the order of the fields in the QVD file.\n\n#### `toQvd(path: string): Promise\u003cvoid\u003e`\n\nThe method `toQvd` writes the data frame to a QVD file at the specified path.\n\n## License\n\nCopyright (c) 2024 Constantin Müller\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[MIT License](https://opensource.org/licenses/MIT) or [LICENSE](LICENSE) for\nmore details.\n\n### Forbidden\n\n**Hold Liable**: Software is provided without warranty and the software\nauthor/license owner cannot be held liable for damages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuellerconstantin%2Fqvd4js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuellerconstantin%2Fqvd4js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuellerconstantin%2Fqvd4js/lists"}