{"_id":"@coremyslo/svg-to-icon","_rev":"3-0251fc3e4d8857b8687992115024ad41","name":"@coremyslo/svg-to-icon","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@coremyslo/svg-to-icon","version":"1.0.0","main":"dist/index.js","types":"dist/index.d.js","repository":{"type":"git","url":"git+https://github.com/coremyslo/svg-to-icon.git"},"keywords":["icon","svg","glyph","icon font"],"scripts":{"build":"tsc -p tsconfig-build.json","lint":"eslint --fix --ext .ts .","dev":"yarn lint && yarn build && yarn icon-font","test":"jest"},"dependencies":{"case":"^1.6.3","is-svg":"^4.3.2","svgo":"^3.0.2"},"devDependencies":{"@types/jest":"^29.4.0","@types/node":"^18.14.1","@types/svgicons2svgfont":"^10.0.1","@typescript-eslint/eslint-plugin":"^5.53.0","@typescript-eslint/parser":"^5.53.0","eslint":"^8.34.0","eslint-plugin-jest":"^27.2.1","jest":"^29.4.3","svgicons2svgfont":"^12.0.0","ts-jest":"^29.0.5","typescript":"^4.9.5"},"license":"MIT","gitHead":"a9470c238b1222f0c690885c61dc5ee88481e4a4","description":"This module represents a helper class for reading and optimizing SVG files, returning their name based on path and file content, and generating glyphs ## Installation","bugs":{"url":"https://github.com/coremyslo/svg-to-icon/issues"},"homepage":"https://github.com/coremyslo/svg-to-icon#readme","_id":"@coremyslo/svg-to-icon@1.0.0","_nodeVersion":"16.17.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-t1+m0LA4q+D6xVlBHygLAUz+EWEX05c8NN18/3WJRXiryb5xN8SGrlZyD/xbtink89jAwrdjscj+jeODUG6f8w==","shasum":"75e60178dd6b829cdd16dad8c7cea98ef4dcd277","tarball":"https://registry.npmjs.org/@coremyslo/svg-to-icon/-/svg-to-icon-1.0.0.tgz","fileCount":19,"unpackedSize":30515,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGUE4rWodXYavR5vQ6WOFP3yBYgT/y/IJ4l1BYpjuApiAiAMqarSx1CmtbJhnK+MJxQiJrHK/5hET5xYN16hCtRutw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj/hiJACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpjlg//TlIxU9JVelJN6DsEiLza4iVleCv7OkVoTWClA32UVYRl/nqO\r\nRR4bdf5pqU8ceoVjHMADlUfTm6U+4w6d8XFipZLNObQRqagPOghhK/dH/BtV\r\ngIN5i1OdN+OOywVc2YG0l0lfiRQZsQzUqNcab+0E1JWVwmkh2KOgiM1wuR8+\r\n1j6qTMC3+kJo0cBPy9kEdhubFf1L6exXXDbQdhIrGzJQY7L2H1mBcrbIgl5A\r\n6GiRC2VPM1Q5KL53KKGA4WTe8E6gvnt02R4HjdKnJ9xYKXPSfdTnk83yqXwt\r\n+fuXT5tXMpHuuhLQfOcSfc41BvtwbHj6S2sjidVY/ThHwgznm5XiMIkiCI2N\r\natl936AnDWrvj+6K9rS9pnKO3mBG8L7u0NgRibQXSQpmQhnYQMIQs5eUAEdP\r\nRLyCg9/FK4/jUmF7nvVXSFmlAFdXsY+sqMcnFVmGr04RxtcnqA8ky+vp/ont\r\nVi/TtLQBZ19abLqB5GMoKLUk810lwl/94we0TNw841IKBAAxyaP3gpF5kfqH\r\neGIM7GJ4tjFKxh1t1Dc0gzrt+pc5i3LPyh3SIhFj4EmTwPgODRy2wNKjVMpR\r\nFwiKCU5SR+AYCDrOimwP6ZDj1PDqrXS9oRj8iWScaYVV/cBIg0HKzA222isQ\r\nl2lzOSQnVrT0YWS6QkpujFEAmowF3cKNUyI=\r\n=IUgX\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"coremyslo","email":"coremyslo@gmail.com"},"directories":{},"maintainers":[{"name":"coremyslo","email":"coremyslo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svg-to-icon_1.0.0_1677596809702_0.25044448629752525"},"_hasShrinkwrap":false},"1.0.1":{"name":"@coremyslo/svg-to-icon","version":"1.0.1","main":"dist/index.js","types":"dist/index.d.js","repository":{"type":"git","url":"git+https://github.com/coremyslo/svg-to-icon.git"},"keywords":["icon","svg","glyph","icon font"],"scripts":{"build":"tsc -p tsconfig-build.json","lint":"eslint --fix --ext .ts .","dev":"yarn lint && yarn build && yarn icon-font","test":"jest"},"dependencies":{"case":"^1.6.3","is-svg":"^4.3.2","svgo":"^3.0.2"},"devDependencies":{"@types/jest":"^29.4.0","@types/node":"^18.14.1","@types/svgicons2svgfont":"^10.0.1","@typescript-eslint/eslint-plugin":"^5.53.0","@typescript-eslint/parser":"^5.53.0","eslint":"^8.34.0","eslint-plugin-jest":"^27.2.1","jest":"^29.4.3","svgicons2svgfont":"^12.0.0","ts-jest":"^29.0.5","typescript":"^4.9.5"},"license":"MIT","gitHead":"8635507987b090c9f79394fae7e93d745e5dbdb6","description":"This module represents a helper class for reading and optimizing SVG files, returning their name based on path and file content, and generating glyphs ## Installation","bugs":{"url":"https://github.com/coremyslo/svg-to-icon/issues"},"homepage":"https://github.com/coremyslo/svg-to-icon#readme","_id":"@coremyslo/svg-to-icon@1.0.1","_nodeVersion":"16.17.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-gnAwybRrkgXc7sym81UuNynn7mFJSKRfCyCyYeXSzvIk34RRvls6QNd0z39TOCA6J5GJ/8GfJ5YwmOQQvUUIgA==","shasum":"abee26c2f246e994b578847188fdb99266b4b6d7","tarball":"https://registry.npmjs.org/@coremyslo/svg-to-icon/-/svg-to-icon-1.0.1.tgz","fileCount":19,"unpackedSize":30320,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHMkuUrP3+uDhjZiRGn97myFbA+I5SI5yvoSkfInVSIcAiBNrL7xsIvY1LVqiBZ0sBmPjaT15YlNy0O2rVZzeG8tIg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAMwjACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmonCw//Qg5oyMq2X/CRwkjric4GIBc0+Tw+3qZ8c+O1bW+ydh8j1Nsk\r\nJLwG+o9CPfU3Lv68H8DaTW8d3zP8PUvZOg72ezSVyG5c1bRo2bfOQdhmnJ2S\r\nrNCYF8hMiNDy5tg00LDtNv7klcvPDE5U+25AG6XO8WCJEoGZklyHrJDF9BL8\r\nUO3zRxSJGFkdBB0T055DgRDqem3KUgOTzcD/Rnui16U2CBegbtUCOY3kMEK5\r\nIYPSngewCkTzFimBmk0yfiAO86nC7oOV3NaOT0Ad3O6Rq503yoPEqwiYZ8sW\r\nztowTMl0JqOrkkDHzGKSOctbRkm2XYOZPzPqlGhoHf9hxLkSo+FxiUkGomzo\r\n9eiDGZCITHwiMUq+DYyHxKYBYk9QLr60RcvTS21O/8GzqRNfZmFzfCmm9vWL\r\njRLfhmzrLE43Yu2zy/KZojOcxW6uSEcPHN4NOFfmqro9WEMM4DyndBXIMhD6\r\nAQAAONovcgQCFeFQoPyeE75/fZXXdLgaaWnkip8/fWjSUyRNg0ICkpaovD/7\r\nLJMSbfj4CWNHZ0xsPTCq2SiE2kiEGxZ1Wh85oiz1po0kktohWmToodK/i0JZ\r\nHP5wZSVt61IaPaDNR1mbKvieeDtjLZ+KXOR6OsugDq+F45hg5ed5TLZY87AO\r\nzRCA0ljhL84xhcpv5lWt7+L/onsjwIVGTng=\r\n=tt1a\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"coremyslo","email":"coremyslo@gmail.com"},"directories":{},"maintainers":[{"name":"coremyslo","email":"coremyslo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svg-to-icon_1.0.1_1677773859622_0.4492154747688386"},"_hasShrinkwrap":false},"1.0.2":{"name":"@coremyslo/svg-to-icon","version":"1.0.2","main":"dist/index.js","types":"dist/index.d.js","repository":{"type":"git","url":"git+https://github.com/coremyslo/svg-to-icon.git"},"keywords":["icon","svg","glyph","icon font"],"scripts":{"build":"tsc -p tsconfig-build.json","lint":"eslint --fix --ext .ts .","test":"jest","dev":"yarn lint && yarn build && yarn test"},"dependencies":{"case":"^1.6.3","is-svg":"^4.3.2","svgo":"^3.0.2"},"devDependencies":{"@types/jest":"^29.4.0","@types/node":"^18.14.1","@types/svgicons2svgfont":"^10.0.1","@typescript-eslint/eslint-plugin":"^5.53.0","@typescript-eslint/parser":"^5.53.0","eslint":"^8.34.0","eslint-plugin-jest":"^27.2.1","jest":"^29.4.3","svgicons2svgfont":"^12.0.0","ts-jest":"^29.0.5","typescript":"^4.9.5"},"license":"MIT","gitHead":"e6c736ab7ad965d0667538d82415d5ab2e576deb","description":"This module represents a helper class for reading and optimizing SVG files, returning their name based on path and file content, and generating glyphs ## Installation","bugs":{"url":"https://github.com/coremyslo/svg-to-icon/issues"},"homepage":"https://github.com/coremyslo/svg-to-icon#readme","_id":"@coremyslo/svg-to-icon@1.0.2","_nodeVersion":"16.17.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-YyfYcfniXoc7CMsyJMCUomaiHDccGrEqS+LfwLdZJjzLrLeCh9JfS8ImpGnVPj734TfqPuEdCMTPyfF0e9y2FA==","shasum":"e498d70d35a5e9faf2b7b2c4f4185e1b7e60f579","tarball":"https://registry.npmjs.org/@coremyslo/svg-to-icon/-/svg-to-icon-1.0.2.tgz","fileCount":19,"unpackedSize":30315,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGLsX4FWL+X5rcWqyugpMnwUsAJdGLjxz+fbiBCvXFTnAiEAoNiAZPgPBmsh8aWPXOeHPMAxEPYvmvV6lGa1i3slSEI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkJYElACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqMRw/+MnFwbeevKPcPv2w6mkvtHYThlmy5NPji47SOVPiMGVT9lzF0\r\nVAXwLQFsxd1OeDarVItxMUQsA5b74pnG4/jyVx/bw9+W/n9+jVFMSmIXeCHB\r\nvV/vf8PzoE7cGyfFHSxgz619ZOV2KZ13Jlvm7W/kZepYrtKSZXF0n4r96VaB\r\nSGPn5SQYN7zVXvXpDuLWRLFM7jCq6vHRqmnMn3oF1iFyRAlalekZCTjzzSkh\r\na9t+TbnbEVTfcOJBENpayJ+2eFzaWS2q2lyUcEqDOZ8Zm9mp99Iyhk+lIyxu\r\n3ldFq2AD3NdWQRJIUGEUlvp/+jUd/WZEfHGoWxsQI7uz1haYXnaXTy8s1g9S\r\n0LxPXoxkCBYqSIWC+Q6LmoJWQ2Ddpjf/cEMjjyOfKmJ3pgwWfM6mOgaH0PPb\r\nptFXJPm2MgvXXTMvkrVluZ/B8iB0aOYv2p4e8tfbcMyfN0zYKIaqtmlica0D\r\n9dLRL0DAwX1EpCIzTpxiXrT2fB5jVk5rea1laXNZS4e91tOt0x1rZFKEwB5I\r\nP9/vS0kNVSdi5fYcUfZJi8uzWMUHPPtsRpaUYJaujii9oI2xF+l0qWuNuSso\r\nyuWABr408EYVlOQj2Gk37+muMfs86sXMJf19Oyn4sQaBvLldlGzNGk/Rdx6T\r\nLqLStL1+DmEufR0LYuC+7bl2ko7+FkSiWXU=\r\n=Ac9t\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"coremyslo","email":"coremyslo@gmail.com"},"directories":{},"maintainers":[{"name":"coremyslo","email":"coremyslo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svg-to-icon_1.0.2_1680179492799_0.6789107716256473"},"_hasShrinkwrap":false},"1.1.0":{"name":"@coremyslo/svg-to-icon","version":"1.1.0","main":"dist/index.js","types":"dist/index.d.js","repository":{"type":"git","url":"git+https://github.com/coremyslo/svg-to-icon.git"},"keywords":["icon","svg","glyph","icon font"],"scripts":{"build":"tsc -p tsconfig-build.json","lint":"eslint --fix --ext .ts .","test":"jest","dev":"yarn lint && yarn build && yarn test"},"dependencies":{"case":"^1.6.3","is-svg":"^4.3.2","svgo":"^3.0.2"},"devDependencies":{"@types/jest":"^29.4.0","@types/node":"^18.14.1","@types/svgicons2svgfont":"^10.0.1","@typescript-eslint/eslint-plugin":"^5.53.0","@typescript-eslint/parser":"^5.53.0","eslint":"^8.34.0","eslint-plugin-jest":"^27.2.1","jest":"^29.4.3","svgicons2svgfont":"^12.0.0","ts-jest":"^29.0.5","typescript":"^4.9.5"},"license":"MIT","gitHead":"ce4c89c62d6c715da31149f6c8ff4acbca136fd4","description":"This module represents a helper class for reading and optimizing SVG files, returning their name based on path and file content, and generating glyphs ## Installation","bugs":{"url":"https://github.com/coremyslo/svg-to-icon/issues"},"homepage":"https://github.com/coremyslo/svg-to-icon#readme","_id":"@coremyslo/svg-to-icon@1.1.0","_nodeVersion":"16.17.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-u9bWeg8f+2cO9uWugFPR9L3zS4/lizGO+jQnXxcSnc7wECjfMs+ZCLVfzofPPEZNpvEwFAdcz/DTE8NenkPUlA==","shasum":"cd066cb845a102ed40b8c9f1b08ae3106b2d4429","tarball":"https://registry.npmjs.org/@coremyslo/svg-to-icon/-/svg-to-icon-1.1.0.tgz","fileCount":19,"unpackedSize":30696,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDtZns95LQkvQ5v/DzaygSftGV0x+xvWNNt3A6ycRTm9QIgWRhno87Rqw4maciF3EXCn6sKXNgIWp4WaVSDDy1evQE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkNx9nACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpG2w//Zwevxaxh+kRoZ+DRsMYVRFtZik+ZOta20W7z+yY1Gcjf5aqh\r\nLBF6AyRIX7xSFIiOF4oGpBL+f5GbZccJIpROOfEfRoDnksj78GQSk1ec01EP\r\nLMD7jzeq67lv09soiK9YdX5H05yj0XGJQiX8CxM6LtggnDHVAz1mji+Im1Td\r\nMYwGUWLiS7WKS51TLYuTXG2n/3n2/ZyeWnzmBzuui8GaBFe4ouQfYfrdJaAS\r\nR6bCK/JiiNTBXZ3OtUrMtbd5rFTx7KKrxa/TUXWiD0wBnUP8zD7/P2OeS/fD\r\n/2W1pAqM9NjyIhE5aBbyAN0ESYinyV8oqUx+wFXNptB81VTj/u/bJi9R/C4C\r\noMe6SIdnkBFCJU+W40Wz08eKiHyDQkk4AJ04Gnm20hbHyrQrDEL7+F0Iv6aT\r\nIG2Eg6ervh7ySKCUhIJm8HnpltmYFZfupiMSc/K1TyLkuC7eA76FDWN5gFir\r\n5giDWfAsPqDUNdWCeFKhfknB8taw7hJUsBnoGQI362rdU4H8yGpVQDilU6wb\r\nJwMNW+2e8vPVn8bPjOYWTsEkxxmDRdpIH8Eh2+AJMMTeEiP2LmgcRsEBr2Jp\r\n+7OsGe3eJFZ0ZaTof7FJTyyoltVYCy5fRBhX+7uDDZoF/afT+xoQq5phiB9g\r\nKEpkHkHKL0To2u9venjKf/baNV/bPBHDpCs=\r\n=f0Mp\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"coremyslo","email":"coremyslo@gmail.com"},"directories":{},"maintainers":[{"name":"coremyslo","email":"coremyslo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/svg-to-icon_1.1.0_1681334119670_0.34914758061394613"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-28T15:06:49.474Z","1.0.0":"2023-02-28T15:06:49.868Z","modified":"2023-04-12T21:15:19.926Z","1.0.1":"2023-03-02T16:17:39.821Z","1.0.2":"2023-03-30T12:31:33.035Z","1.1.0":"2023-04-12T21:15:19.830Z"},"maintainers":[{"name":"coremyslo","email":"coremyslo@gmail.com"}],"description":"This module represents a helper class for reading and optimizing SVG files, returning their name based on path and file content, and generating glyphs ## Installation","homepage":"https://github.com/coremyslo/svg-to-icon#readme","keywords":["icon","svg","glyph","icon font"],"repository":{"type":"git","url":"git+https://github.com/coremyslo/svg-to-icon.git"},"bugs":{"url":"https://github.com/coremyslo/svg-to-icon/issues"},"license":"MIT","readme":"# @coremyslo/svg-to-icon [![npm](https://img.shields.io/npm/v/@coremyslo/svg-to-icon)](https://www.npmjs.com/package/@coremyslo/svg-to-icon) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/coremyslo/svg-to-icon/blob/master/LICENSE)\n\nThis module represents a helper class for reading and optimizing SVG files, returning their name based on path and file content, and generating glyphs\n## Installation\n\n```shell\n$ yarn add @coremyslo/svg-to-icon\n```\n\n\n## Usage\n```typescript\nimport { Icon } from \"@coremyslo/svg-to-icon\";\n\nconst pathToFile = path.join(__dirname, \"./assets/icons/icon-home.svg\")\nconst icon = new Icon(pathToFile);\n\nconsole.log(icon.name) // returns \"icon-home\"\n\nawait icon.read();\nconsole.log(icon.content) // returns file's content as a string\n\nicon.optimize();\nconsole.log(icon.content) // returns optimized file content as a string\n```\n### Usage for icon font generation\nThe following example is based on [svgicons2svgfont](https://www.npmjs.com/package/svgicons2svgfont)\n```typescript\n// ...\n\nconst unicode = \"0xE900\";\nconst glyph = icon.getGlyph({\n    metadata: {\n        name: icon.name,\n        unicode: [String.fromCharCode(parseInt(unicode, 16))],\n    },\n});\n\nconst getFontStream = (glyphs: Readable[]): Promise<Uint8Array> => new Promise(resolve => {\n    const chunks: Uint8Array[] = [];\n    const fontReadStream = new SVGIcons2SVGFontStream({\n        fontName: \"iconFont\",\n        fontHeight: 1024,\n        normalize: true,\n        round: 1,\n        log (): void { },\n    }).on(\"data\", (chunk: Uint8Array) => {\n        chunks.push(chunk);\n    }).on(\"end\", () => {\n        resolve(Buffer.concat(chunks));\n    });\n    fontReadStream.write(glyphs[0]);\n    fontReadStream.end();\n});\nconsole.log((await getFontStream([glyph])).toString());\n\n\n/* will log\n\n<?xml version=\"1.0\" standalone=\"no\"?>\n<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\" >\n<svg xmlns=\"http://www.w3.org/2000/svg\">\n<defs>\n  <font id=\"iconFont\" horiz-adv-x=\"1024\">\n    <font-face font-family=\"iconFont\"\n      units-per-em=\"1024\" ascent=\"1024\"\n      descent=\"0\" />\n    <missing-glyph horiz-adv-x=\"0\" />\n    <glyph glyph-name=\"icon-home\"\n      unicode=\"&#xE900;\"\n      horiz-adv-x=\"1024\" d=\"M235 192H395V459H629V192H789V608L512 816L235 608zM171 128V640L512 896L853 640V128H565V395H459V128zM512 505z\" />\n  </font>\n</defs>\n</svg>\n\n*/\n```\n\n## API\n### new Icon(sourceFilePath, options)\n* `sourceFilePath: string`\n\nAbsolute path to the icon file\n* `options: object`\n  * `case: \"snake\" | \"pascal\" | \"camel\" | \"kebab\" | \"header\" | \"constant\"` - optional, define case for icon name, see [case](https://www.npmjs.com/package/case) package for details.\n    ```typescript\n    import { Icon } from \"@coremyslo/svg-to-icon\";\n\n    const pathToFile = path.join(__dirname, \"./assets/icons/icon-home.svg\")\n    const icon = new Icon(pathToFile, { case: \"camel\" });\n    console.log(icon.name) // logs \"iconHome\"\n    ```\n  * `sourceDirPath: string` - optional, absolute path to root folder for icon. If not set, only the filename of the icon will be considered as the name of the icon.\n    ```typescript\n    import { Icon } from \"@coremyslo/svg-to-icon\";\n\n    const pathToFile = path.join(__dirname, \"./assets/icons/icon-home.svg\")\n    const icon = new Icon(pathToFile, { sourceDirPath: \"/assets/\" });\n    console.log(icon.name) // logs \"icons-icon-home\"\n    ```\n### `read(): Promise<this>`\nAsynchronously reads the file specified by the sourceFilePath parameter passed to the constructor.\n\n### `optimize(config: Config): this`\nSynchronously rewrites `icon.content` with the optimized version of the SVG, using the [svgo](https://www.npmjs.com/package/svgo) package.\n* `config: Config` - optional, configuration object for the [svgo](https://www.npmjs.com/package/svgo) package. If not set, the default configuration will be used.\n\n### `getGlyph(options): Readable`\nReturns a node `Readable` stream object.\n* `options: object` options passed to node's [Readable.from](https://nodejs.org/api/stream.html#streamreadablefromiterable-options) under the hood. This method is used to generate a glyph from the SVG icon.\n\n### `content: string`\n* Contains the file content after `read()` has been executed.\n### `name: string`\n* Contains the name based on the file name and root folder if `sourceDirPath` was passed to the constructor.\n","readmeFilename":"README.md"}