{"_id":"@calme1709/id3-js","_rev":"8-f624cbfa147521803e9f5791923285ea","time":{"1.0.0":"2019-11-15T12:45:50.115Z","1.0.1":"2019-11-15T12:45:50.115Z","created":"2019-11-15T12:46:59.512Z","1.0.2":"2019-11-15T12:46:59.958Z","modified":"2022-04-04T21:33:27.748Z","1.0.3":"2019-11-17T02:38:17.900Z","1.0.4":"2019-12-05T10:34:32.125Z","1.0.5":"2019-12-05T10:45:22.739Z"},"name":"@calme1709/id3-js","dist-tags":{"latest":"1.0.5"},"versions":{"1.0.2":{"name":"@calme1709/id3-js","version":"1.0.2","description":"A library for reading and writing ID3 data.","main":"index.js","types":"index.d.ts","scripts":{"build":"tsc","test":"tsc && node dist/index.js"},"keywords":["metadata","id3","typescript","music","mp3"],"author":{"name":"Calme1709"},"license":"ISC","repository":{"url":"git+https://github.com/Calme1709/id3-js.git"},"devDependencies":{"@types/iconv-lite":"0.0.1","@types/node":"12.12.7","tslint":"5.20.1","tslint-eslint-rules":"5.4.0","typescript":"3.7.2"},"dependencies":{"iconv-lite":"^0.5.0"},"gitHead":"fdaa9255a1d1a7ebd8b28c5f4140f15ae7e60751","bugs":{"url":"https://github.com/Calme1709/id3-js/issues"},"homepage":"https://github.com/Calme1709/id3-js#readme","_id":"@calme1709/id3-js@1.0.2","_nodeVersion":"13.1.0","_npmVersion":"6.13.0","dist":{"integrity":"sha512-VqXFKVE1aNyMihdqKgleHwE3KcCwE17NVfbni6fAzTpacWGChmStCxdBSP3ufiH1aRSboLF/QbGfjcyv3MKhyQ==","shasum":"c2e358fd8e3e0f65d1906cb70b810c6b02c7a820","tarball":"https://registry.npmjs.org/@calme1709/id3-js/-/id3-js-1.0.2.tgz","fileCount":12,"unpackedSize":46468,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzp5ECRA9TVsSAnZWagAACKEP/AwkH1nC+iWuW0IlXmKO\n5x6/flOtMdz6ry3Jh25czNm6Ammb0y281dIouOY2e4/dEKBFZluJfG0VJ8T5\n8uAiyuBVHDum1VpPINW3MIuLmYqDBKuzz2eKUvETZ8cwC4Yd1DIcrha0hlPD\n6ywTFH1uheMWpsU+Rfg65n/jIYoNTqeGtk22Fv9eJv21xHyhwyCEqmEjuc0C\nE3BSsZnFj5IBRpwdyapDUFVt893Y3JTULSE65S2bj5u9qO1O/gvVXVNCO/fT\njpdAroX0DAJsrIf39LFpQVJoQmFvc15gSowHHyiV+GyL2hlxxgLHrApbSZvA\nOI48qHLH/1qsNYKYtSWR4V544wqiRZYZTdENQo8L7UrcWWYvlf0Z7gWK3dlE\n/DSkTu5DUBaHCgx/i12GTu8YIm9QLqwmoxWcf/8eeJEM8xxyY29ULG8wZ+ew\nZkkVal0CYoafYz1GFtrmXAY1GPaxQq92nylAARDDdExzkWzFtsSxZ86tUckk\n2ZTYnbt6N90ilkAITQo9YJwEUosTtwLKwzh7e+dJFJBDe6zemG5QZTuZj5tM\n0mB5PaB3cJvZVTqlEmEB6c9ETBszsdI8CY9qQLrqj08iT805oGg+CdduoCHo\n4DTYO8wIsyIoCv0e9xkXIgutGUH3fXwbVPA8QA3nyvyC9RZagQGh4pWZ7lGm\nzMOe\r\n=szRT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDVrRggcgaPO4iaKhn4ifp7yNc88WcS3ViJdQ5AwpTPPwIgGanzf22RCGXEtFySZ6IL+U9SzjoyXh2EGLZIsi3CyM0="}]},"maintainers":[{"name":"calme1709","email":"Callumlaw1709@gmail.com"}],"_npmUser":{"name":"calme1709","email":"Callumlaw1709@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/id3-js_1.0.2_1573822019832_0.14935761619846"},"_hasShrinkwrap":false},"1.0.3":{"name":"@calme1709/id3-js","version":"1.0.3","description":"A library for reading and writing ID3 data.","main":"index.js","types":"index.d.ts","scripts":{"build":"tsc","test":"tsc && node dist/index.js"},"keywords":["metadata","id3","typescript","music","mp3"],"author":{"name":"Calme1709"},"license":"ISC","repository":{"url":"git+https://github.com/Calme1709/id3-js.git"},"devDependencies":{"@types/iconv-lite":"0.0.1","@types/node":"12.12.7","tslint":"5.20.1","tslint-eslint-rules":"5.4.0","typescript":"3.7.2"},"dependencies":{"iconv-lite":"^0.5.0"},"gitHead":"9f704281d469c94f2fdffef9bc0c60a5b7999fee","bugs":{"url":"https://github.com/Calme1709/id3-js/issues"},"homepage":"https://github.com/Calme1709/id3-js#readme","_id":"@calme1709/id3-js@1.0.3","_nodeVersion":"13.1.0","_npmVersion":"6.13.0","dist":{"integrity":"sha512-55ZWmrCYdpFQrAdqjR+kVujupJykGfalj8qUVjlbCn2w4tKGn3H2vLd/NxTkEeicmqh9IDjBU1cuIEvg7J/BTA==","shasum":"6f15bb2b1339fdc1ba6aacde306305c5d3d95a02","tarball":"https://registry.npmjs.org/@calme1709/id3-js/-/id3-js-1.0.3.tgz","fileCount":12,"unpackedSize":46823,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd0LKaCRA9TVsSAnZWagAAD6wP/R7cS011o+MbzCHU/Rpd\nK8WipPCHmHvczXHpRoMgVyq0ht+CkgYb7V+fJBfnAodQCvQonoDb1U1zLK+S\nosTg6U58Z7n+/qYwU2hLxQnYUv3h84KFFo96r3NZX5irVt/4et9R5byDncE4\nw41X66N7JaBsE09cIgTI1ZFOG9UDIcbVm1ysDChzvW+xLaH+X6l6yshu5fNT\n3+1c7gPCdvdz1KNqid5FxUBQjgAjsT7RCcLObQPzU8vr26moeMweP9lx6VTL\nBKvmLyiGG9s4I7TdI50M3YrYfX19hk1WINggupb4QHiCwrrZYe7UspQ4lxoN\nfqJW4vQWg0ju1LDZX0znf0mIoVTSmKsuYKcV2uRdZSDB2XSVj+KOfV9WEAth\nnx2xlDBWGGngirPoR3ti4GTmf2d4ncHxkpCOqJ7+4mS6wTruVZ4V647d0A+a\nKKheFerAi+nfYOfzYBpmt0MZeT4BMSBQcG0Ch5nn05uoEHBLwSOtfHiE3spn\ndJE9HEkJ7ywKAvvQIs4BGSd1X7NEUFvKYnFM/xO65rDRKQ1uInQ/xhcGYBkm\nQvYPtJUDWgg7H2l8B5Qtg7heFce3209NcEPYXsGJeRP+ItNP18HltfslGoLE\n0XmkX/JYziCSW5v1gTp5SxA/Om4rVP2OLXMamlkO+yt3nrpSEOfrl+skyOZP\nUQ7/\r\n=QTGR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFM3QlS1zoO/XbVLmWl5+zCjbEaWRnLxWIog/B+IwY2FAiA+Bv7cboGHpaRZcJNSEldIQPEgy0TtHm2VUHHzyZ11hQ=="}]},"maintainers":[{"name":"calme1709","email":"Callumlaw1709@gmail.com"}],"_npmUser":{"name":"calme1709","email":"Callumlaw1709@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/id3-js_1.0.3_1573958297777_0.21822657512069954"},"_hasShrinkwrap":false},"1.0.4":{"name":"@calme1709/id3-js","version":"1.0.4","description":"A library for reading and writing ID3 data.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","test":"tsc && node dist/index.js"},"keywords":["metadata","id3","typescript","music","mp3"],"author":{"name":"Calme1709"},"license":"ISC","repository":{"url":"git+https://github.com/Calme1709/id3-js.git"},"devDependencies":{"@types/iconv-lite":"0.0.1","@types/node":"^12.12.14","tslint":"5.20.1","tslint-eslint-rules":"5.4.0","typescript":"^3.7.3"},"dependencies":{"buffer":"^5.4.3","iconv-lite":"^0.5.0","react-native-fs":"^2.16.2"},"bugs":{"url":"https://github.com/Calme1709/id3-js/issues"},"homepage":"https://github.com/Calme1709/id3-js#readme","_id":"@calme1709/id3-js@1.0.4","_nodeVersion":"13.3.0","_npmVersion":"6.13.1","dist":{"integrity":"sha512-Z8bsZXoyXas2CqrukAQpZMnLUbSqqPS4AMq5snzGcrG7ePLWNl8SKy40KItsNPNU+kXuMEqsvq1Ykp2ET7x91Q==","shasum":"003365aa292bb93628936fb6b9f3dccba8d19a57","tarball":"https://registry.npmjs.org/@calme1709/id3-js/-/id3-js-1.0.4.tgz","fileCount":12,"unpackedSize":57579,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6N04CRA9TVsSAnZWagAAfu0P/io/mb6YlG5TkZgOEewN\nGzTi+t8kqBMPF0AgKrWG+YEbQZ5ZZQoUF9o0skbssogA5uzgezhcDO77EMui\nTOuw1hS5lQEjMVKREXkmyKIStNW0Wt5wJbXwkZVs53Tc9jkSAJPj6ak5nf4x\nNQpisfbIyVcs65pR+TAda+nh1YFspSC5s4sMU+l8Autv+C+rT25hFk05Y2ct\n5IJrCV6VhL8NfN6qgMsI4uRC4jyEynpY2FCA4CnGvFhHd5wdzeW7WSSh6ALH\n3gPU1X0I9Xxi5ck1FJpNCJaDQVcTytF9WZsw3PCvBmvMcoIbWDjpx13r37HO\neFLB5EUmK/2DTT89fvWpOzJXwPFfwkBQoNPjP5DudVSdX94f2La+0eUxIG+i\nJuIoIZZRsf04Kfq0F751+j6k9JvrvAMHvR65ejHuFVGa5QtU2GOYsPoB0li1\nVr1zjv0IrhW/pFES94lRUVABVxJlfR/y74/TZrYHZ2ft9VfbDY5x6OZZ2mHo\nJNjgI4amJP5XarV2y04gAJecRhAYo+3ncO0IhKqaEsYWLC7OF9spoBYlKn3R\nwZBqpSt1NwPBSfkR8S4u8Ujw0f4Dd21RnGNa2s3Wd43oQfwwgTEhxswt1pLU\nNxNMqV4YQtTe3pTZchTz/7NqwLM1hHYbRHbSRU/AIzk0P0m7bZLrddtJ7aXF\ntQ4r\r\n=SGp1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDTodNFn7qGNX8vgT9SvfU1S9r1pZAyJO+GvsxwiTCKbgIgJqAqIwu96BQvqYWpcYHsflh7FKOYvWuOFEPPCLgKAkE="}]},"maintainers":[{"name":"calme1709","email":"Callumlaw1709@gmail.com"}],"_npmUser":{"name":"calme1709","email":"Callumlaw1709@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/id3-js_1.0.4_1575542071952_0.8347567995671832"},"_hasShrinkwrap":false},"1.0.5":{"name":"@calme1709/id3-js","version":"1.0.5","description":"A library for reading and writing ID3 data.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","test":"tsc && node dist/index.js"},"keywords":["metadata","id3","typescript","music","mp3"],"author":{"name":"Calme1709"},"license":"ISC","repository":{"url":"git+https://github.com/Calme1709/id3-js.git"},"devDependencies":{"@types/iconv-lite":"0.0.1","@types/node":"^12.12.14","tslint":"5.20.1","tslint-eslint-rules":"5.4.0","typescript":"^3.7.3"},"dependencies":{"buffer":"^5.4.3","iconv-lite":"^0.5.0","react-native-fs":"^2.16.2"},"bugs":{"url":"https://github.com/Calme1709/id3-js/issues"},"homepage":"https://github.com/Calme1709/id3-js#readme","_id":"@calme1709/id3-js@1.0.5","_nodeVersion":"13.3.0","_npmVersion":"6.13.1","dist":{"integrity":"sha512-dvl7nlr26S3PVxHoFRAw3pa43LFvqrfOz8li1HYco+19S1GjLP9Xk0jy5wHHwwQJVgZr3kA4oRO1vJXwrbe7Sw==","shasum":"924a78efd05c8ce7df3abf13c318ee23ecd11e21","tarball":"https://registry.npmjs.org/@calme1709/id3-js/-/id3-js-1.0.5.tgz","fileCount":12,"unpackedSize":57579,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6N/DCRA9TVsSAnZWagAAHOAP/isGgVJtinRRh/6fTYYy\nKVm2OoE8akhnD0wtz6dT8YE0KBOzjjXw0f8P1mpWSM+TNz9SHZJHKr3Ako36\nQreW8QYM1eF5+bJgAkPJoWVVfr+GwJrM73PkYk8s8RFX6wI9jfO0p40t0tel\nu1G1FyHp/sou30G9VGAJAZ2hHCmty6DCc8K/vaGBe8DSgsK2TQyIie2VeOVX\nqoARnOr0oIw3C9gZrkBDJowz8DA5XUHaGgUjpiOSWOAN1+phEN8BC/zWL3w2\n72myiwoibi7utt5TPD4hjxC1eNM8VML97ksFhJnYxkwGiOFZvesHBDSJi3PW\nBHZd+lIJGsd+mbwcJMQ74C+DaALDV3qxW19UnswdMkSiXqHcKHJkzdRw+fIz\npHmR4h3sgEJmuRDfjfi1G7VfIajcU9vz3zGlqhKgwNlSt9+ojj2YywP79f86\nJjhDXJ50qV+fcivqSMpXgxO/5C9352m97T9LlB/+p7vVCUV+GpLQ04lE2kEt\ndChzs6nPbj14OpxPZgZrIGhNUxoTkWlsM67p1tsImeDdyEupImXOGWnfZRuy\nWD6BMmMfkdTp17Ts5vGg5bgz7nJekN6n/NmyHTfRPG+36uul1ojL5OP43Q2z\nRvClZlGCX8Hg3IQSH7OGzJ7iS83IWChNX/fIkXSAenKUT2hueBawNsMPRod2\nRC38\r\n=viPX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDKXstUMTjchazBySELVcSf9WyTxHvSXvXyJJg7vYAnOwIhALp0C5516KKcRUV+M+C33V+TCcG8Jr+52p8cy6zt3x8b"}]},"maintainers":[{"name":"calme1709","email":"Callumlaw1709@gmail.com"}],"_npmUser":{"name":"calme1709","email":"Callumlaw1709@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/id3-js_1.0.5_1575542722632_0.06563832672922976"},"_hasShrinkwrap":false}},"maintainers":[{"name":"calme1709","email":"Callumlaw1709@gmail.com"}],"description":"A library for reading and writing ID3 data.","homepage":"https://github.com/Calme1709/id3-js#readme","keywords":["metadata","id3","typescript","music","mp3"],"repository":{"url":"git+https://github.com/Calme1709/id3-js.git"},"author":{"name":"Calme1709"},"bugs":{"url":"https://github.com/Calme1709/id3-js/issues"},"license":"ISC","readme":"# ID3-JS\r\nA library for reading and writing ID3 data.\r\n\r\n## How to use\r\n---\r\n\r\nFirst install the package\r\n```\r\nnpm install --save @calme1709/id3-js\r\n```\r\n\r\nAnd then include the package in your code\r\n```javascript\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n```\r\nor\r\n```javascript\r\nconst ID3JS = require(\"@calme1709/id3-js\");\r\n```\r\n\r\nYou can then proceed to use the library in your project\r\n\r\n##### Writing ID3 data\r\n***\r\nWriting ID3 data replaces all the existing data with the data that is passed to the method. If you only want to replace the defined data and leave the rest as it is, use the update method.\r\n###### Write to a file\r\n```javascript\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nID3JS.write(\"./song.mp3\", {\r\n    title: \"Song\",\r\n    artist: \"Artist\"\r\n});\r\n```\r\n###### Write to a buffer\r\n```javascript\r\nimport fs from \"fs\";\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nlet buffer = fs.readFileSync(\"./song.mp3\");\r\n\r\nbuffer = ID3JS.write(buffer, {\r\n    title: \"Song\",\r\n    artist: \"Artist\"\r\n});\r\n```\r\n\r\n##### Reading ID3 data\r\n***\r\n###### Read from a file\r\n```javascript\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nID3JS.read(\"./song.mp3\");\r\n```\r\n###### Read from a buffer\r\n```javascript\r\nimport fs from \"fs\";\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nconst buffer = fs.readFileSync(\"./song.mp3\");\r\n\r\nID3JS.read(buffer);\r\n```\r\n\r\n##### Updating ID3 data\r\n***\r\nUpdating ID3 data only affects those properties which are defined in the new information, the existing data that will not be overwritten is left unaffected.\r\n###### Update a file\r\n```javascript\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nID3JS.update(\"./song.mp3\", {\r\n    title: \"Song\",\r\n    artist: \"Artist\"\r\n});\r\n```\r\n###### Update a buffer\r\n```javascript\r\nimport fs from \"fs\";\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nlet buffer = fs.readFileSync(\"./song.mp3\");\r\n\r\nbuffer = ID3JS.update(buffer, {\r\n    title: \"Song\",\r\n    artist: \"Artist\"\r\n});\r\n```\r\n\r\n##### Removing ID3 data\r\n***\r\n###### Remove data from a file\r\n```javascript\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nID3JS.remove(\"./song.mp3\");\r\n```\r\n###### Remove data from a buffer\r\n```javascript\r\nimport fs from \"fs\";\r\nimport ID3JS from \"@calme1709/id3-js\";\r\n\r\nlet buffer = fs.readFileSync(\"./song.mp3\");\r\n\r\nbuffer = ID3JS.remove(buffer);\r\n```\r\n\r\n## Methods\r\n---\r\n### write()\r\nWrites the specified information to either the file at the passed path, or the passed buffer. Overwrites all information currently in the file, if you want to leave non defined information unaffected use the update method.\r\n##### Overloads\r\n|Call|Description|Return|\r\n|---|---|---|\r\n| write(string, IFrames) | Writes the information passed to the file at the passed path, overwriting any existing data. Returns nothing. | undefined |\r\n| write(buffer, IFrames) | Writes the information passed to the passed buffer and returns it. | Buffer |\r\n\r\n### read()\r\nReads the ID3 information from the file at the passed path, or from the passed buffer.\r\n##### Overloads\r\n|Call|Description|Return|\r\n|---|---|---|\r\n| read(string) | Reads the data from the file at the passed path and returns it. | IFrames |\r\n| read(buffer) | Reads the data from the passed buffer and returns it. | IFrames |\r\n\r\n### update()\r\nWrites the specified information to either the file at the passed path, or the passed buffer. Leaves all information that is not defined untouched.\r\n##### Overloads\r\n|Call|Description|Return|\r\n|---|---|---|\r\n| update(string, IFrames) | Writes the information passed to the file at the passed path. Returns nothing. | undefined |\r\n| update(buffer, IFrames) | Writes the information passed to the passed buffer and returns it. | Buffer |\r\n\r\n### remove()\r\nRemoves all ID3 data from either the file at the passed path, or the passed buffer.\r\n##### Overloads\r\n|Call|Description|Return|\r\n|---|---|---|\r\n| remove(string) | Removes all ID3 data from the file at the passed path. | undefined |\r\n| remove(buffer) | Removes all ID3 data from the passed buffer and returns it. | Buffer |\r\n\r\n## Supported properties\r\n---\r\nInformation in ID3 can be either of two types; either a standard text frame, or a special frame. Below is all of the properties that can be set, to make the usage of this library easier, all properties have been mapped to aliases, however the raw names will be supported in a future update.\r\n#### Text Properties\r\n- album\r\n- bpm\r\n- composer\r\n- genre\r\n- copyright\r\n- date\r\n- playlistDelay\r\n- encodedBy\r\n- textWriter\r\n- fileType\r\n- time\r\n- contentGroup\r\n- title\r\n- subtitle\r\n- initialKey\r\n- language\r\n- length\r\n- mediaType\r\n- originalTitle\r\n- originalFilename\r\n- originalTextwriter\r\n- originalArtist\r\n- originalYear\r\n- fileOwner\r\n- artist\r\n- performerInfo\r\n- conductor\r\n- remixArtist\r\n- partOfSet\r\n- publisher\r\n- trackNumber\r\n- recordingDates\r\n- internetRadioName\r\n- internetRadioOwner\r\n- size\r\n- ISRC\r\n- encodingTechnology\r\n- year\r\n\r\n#### Special Properties\r\nThere are four special properties supported, these are below with their types.\r\n- comment: {\r\n    text: string;\r\n    language: string;\r\n    shortText: string;\r\n}\r\n\r\n- image: Buffer\r\n- unsynchronisedLyrics: {\r\n    text: string;\r\n    language: string;\r\n    shortText: string;\r\n}\r\n- userDefinedText {\r\n    description: string;\r\n    value: string;\r\n}\r\n","readmeFilename":"README.md"}