{"_id":"@cldcvr/protobufjs-typescript-gen","_rev":"7-fd78b401a2247041a4af0ff9fb7e8399","name":"@cldcvr/protobufjs-typescript-gen","dist-tags":{"latest":"2.0.4"},"versions":{"1.0.0":{"name":"@cldcvr/protobufjs-typescript-gen","version":"1.0.0","main":"dist/index.js","author":{"name":"Nikhil Verma","email":"nikhilgotmail@gmail.com"},"license":"MIT","scripts":{"debug":"node --inspect-brk -r ts-node/register src/main.ts","build":"rm -rf dist && tsc","prepublishOnly":"yarn build"},"devDependencies":{"@types/fs-extra":"^9.0.13","@types/eslint":"^8.4.3","@types/glob":"^7.2.0","@types/node":"^17.0.42","@types/prettier":"^2.6.3","@typescript-eslint/eslint-plugin":"^5.28.0","@typescript-eslint/parser":"^5.28.0","eslint":"^8.17.0","ts-node":"^10.8.1","typescript":"^4.7.3"},"dependencies":{"@cldcvr/protobufjs":"^6.11.4","fs-extra":"^10.1.0","glob":"^8.0.3","prettier":"^2.6.2"},"types":"./dist/index.d.ts","gitHead":"20a8909ceaee5db7d6164f7b2c97735ea389e664","description":"![\"\"](\"https://img.shields.io/npm/v/protobufjs-typescript-gen.svg\")
![](\"https://img.shields.io/npm/dm/protobufj","_id":"@cldcvr/protobufjs-typescript-gen@1.0.0","_nodeVersion":"16.12.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-+fmVbuAbXaHQ+a59jLPZ0tJNcVsHDGzPX22NlsRB+eCHhEvS9+4x/xYiXTjrxaVD9nO+sNUyr1c07idj2P1aoQ==","shasum":"63fee295fbdb55a272d5aeff9c447daba38b3e4f","tarball":"https://registry.npmjs.org/@cldcvr/protobufjs-typescript-gen/-/protobufjs-typescript-gen-1.0.0.tgz","fileCount":21,"unpackedSize":31865,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICiucvhXl8cARlF7fqlL1kTQsVI7G1NopyRuxAqvcCLkAiEA9CiI6r+kK9W/2hT8HZi/xZ2y+wsH7Df6L/s9PMu5kHA="}],"npm-signature":"-----BEGIN)
![\"\"](\"https://img.shields.io/npm/v/@cldcvr/protobufjs-typescript-gen.svg\")
![](\"https://img.shi","_id":"@cldcvr/protobufjs-typescript-gen@1.0.1","_nodeVersion":"16.12.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-WlWTXnq1lmvhzOMy0l4pfFKULng5whJEq0f96yGCc95phlZD8UFiZamEHQ9ZW1QcPod/GoFkaRCn0/7jTTaasg==","shasum":"fc86659a4f3232d53d3c1c31ffc0ba8526edb643","tarball":"https://registry.npmjs.org/@cldcvr/protobufjs-typescript-gen/-/protobufjs-typescript-gen-1.0.1.tgz","fileCount":21,"unpackedSize":31888,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDwvgSfGKGNTc7B2jNJY5ZT3FOOMUgaIUl1PIzybrUT/QIgArCDDJRDoWkuPRbkbaFR0+38jD+kQFIIaZfrUmntPXs="}],"npm-signature":"-----BEGIN)
![](\"https://img.shi","_id":"@cldcvr/protobufjs-typescript-gen@1.0.2","_integrity":"sha512-nyl5VAp5sjzxH08ajGAnKSmZD2rQaTfuxu5XXr9W1dLbLvB4U+/3Xw5Pk4o1glVFUm0wCEbX8H2g65l3esiK7w==","_resolved":"/private/var/folders/4g/c60k4dh93pn_8ykwsfq27skm0000gp/T/1990f3041fa4de97ba9aa4ff5d350574/cldcvr-protobufjs-typescript-gen-1.0.2.tgz","_from":"file:cldcvr-protobufjs-typescript-gen-1.0.2.tgz","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-nyl5VAp5sjzxH08ajGAnKSmZD2rQaTfuxu5XXr9W1dLbLvB4U+/3Xw5Pk4o1glVFUm0wCEbX8H2g65l3esiK7w==","shasum":"b17577a2994fd00dba875cc56ae6e22ad953ca77","tarball":"https://registry.npmjs.org/@cldcvr/protobufjs-typescript-gen/-/protobufjs-typescript-gen-1.0.2.tgz","fileCount":21,"unpackedSize":32597,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHrmHoKeucelUGmDDvkEQ+C4OML2SG7764gd4aYa3dWJAiBYua45AvbRtO6Bfi8EkszJIuUtmqqo4g7DhZeto9h+uA=="}],"npm-signature":"-----BEGIN)
![](\"https://img.shi","_id":"@cldcvr/protobufjs-typescript-gen@1.0.3","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-XLlbOWOJOa33vU2L/FBR7v97yQTnSbS87TMY97vXHrdabAtb1tVhSBMclS9WkjeDawzZs1eYuzg6FPFvr08Vrg==","shasum":"fb5f1ae7aee4a839ee1f99c2f3d423b606fe8e19","tarball":"https://registry.npmjs.org/@cldcvr/protobufjs-typescript-gen/-/protobufjs-typescript-gen-1.0.3.tgz","fileCount":21,"unpackedSize":32823,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAZEUf91QS4zA4ZTbEizeQLhR5twgDXTxrgGh2VZcjnaAiBsykLFJNUrJ0KrzQGxiz1C/PBOhEvb8BzJMpUSf0pwEQ=="}]},"_npmUser":{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"},"directories":{},"maintainers":[{"name":"shubhamseervi","email":"shubhamseervi@gmail.com"},{"name":"vikas-cldcvr","email":"vikas@cldcvr.com"},{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/protobufjs-typescript-gen_1.0.3_1684751874605_0.7513443955293473"},"_hasShrinkwrap":false},"2.0.3":{"name":"@cldcvr/protobufjs-typescript-gen","version":"2.0.3","main":"dist/index.js","author":{"name":"Nikhil)
![](\"https://img.shi","_id":"@cldcvr/protobufjs-typescript-gen@2.0.3","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-BRfPoM2O1lYfFDV/K4vxunUVS8OgXgMVcLCzQnBR+ubteWjhjch/zoG33eKAVafPronPVEC+Ur+tdpvF7fipYg==","shasum":"d2efbba5217eba9893e50f6b2a130441ed539c42","tarball":"https://registry.npmjs.org/@cldcvr/protobufjs-typescript-gen/-/protobufjs-typescript-gen-2.0.3.tgz","fileCount":21,"unpackedSize":34597,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCwVgLM2UJvBc2qxtnY10TfaSwzuZnHyl+AcUJcMPgQ/wIhAOpoNFX6TGW4ghEvvrsWQMMXQZ9fEzinNxNHen12kGlW"}]},"_npmUser":{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"},"directories":{},"maintainers":[{"name":"shubhamseervi","email":"shubhamseervi@gmail.com"},{"name":"vikas-cldcvr","email":"vikas@cldcvr.com"},{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/protobufjs-typescript-gen_2.0.3_1687267769572_0.7650550552870188"},"_hasShrinkwrap":false},"2.0.4":{"name":"@cldcvr/protobufjs-typescript-gen","version":"2.0.4","main":"dist/index.js","author":{"name":"Nikhil)
![](\"https://img.shi","_id":"@cldcvr/protobufjs-typescript-gen@2.0.4","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-fI/RsKtp7o3vFCKnXLJfEKZmnxz6H81+pjUkQoLCrlBEn/hyTRSXaidEN5mdMc6y/qqpLORsfVbZJXzerMThKg==","shasum":"27904e6a103b5feabcf6de533d1f8164d51a2951","tarball":"https://registry.npmjs.org/@cldcvr/protobufjs-typescript-gen/-/protobufjs-typescript-gen-2.0.4.tgz","fileCount":21,"unpackedSize":35211,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD/8OmKbboh1LRiQrfPLDlWu2/Yi5lS4QbS6lqUYSRQ6gIgJfgIb3ZttwWBqtysbMIg3qjQRv/ou32VZkazpAa5q/Y="}]},"_npmUser":{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"},"directories":{},"maintainers":[{"name":"shubhamseervi","email":"shubhamseervi@gmail.com"},{"name":"vikas-cldcvr","email":"vikas@cldcvr.com"},{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/protobufjs-typescript-gen_2.0.4_1692875049539_0.1887045750751133"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-15T11:37:57.814Z","1.0.0":"2022-06-15T11:37:58.162Z","modified":"2023-08-24T11:04:10.102Z","1.0.1":"2022-07-11T13:06:35.040Z","1.0.2":"2023-02-22T14:09:45.256Z","1.0.3":"2023-05-22T10:37:54.814Z","2.0.3":"2023-06-20T13:29:29.796Z","2.0.4":"2023-08-24T11:04:09.852Z"},"maintainers":[{"name":"shubhamseervi","email":"shubhamseervi@gmail.com"},{"name":"vikas-cldcvr","email":"vikas@cldcvr.com"},{"name":"nikhilverma","email":"nikhilgotmail@gmail.com"}],"description":"<a)
![](\"https://img.shi","author":{"name":"Nikhil)
![\"\"](\"https://img.shields.io/npm/dm/@cldcvr/protobufjs-typescript-gen.svg\")
\n\n**@cldcvr/protobufjs-typescript-gen** is a tool which used protocol buffers to generate a Typescript interface. The tool is currently highly opinionated in how it generates files. It internally uses protobuf.js.\n\n**protobuf.js** is a pure JavaScript implementation with [TypeScript](https://www.typescriptlang.org) support for [node.js](https://nodejs.org) and the browser. It's easy to use, blazingly fast and works out of the box with [.proto](https://developers.google.com/protocol-buffers/docs/proto) files!\n\n## Installation\n\n### node.js\n\n```bash\n$> npm install @cldcvr/protobufjs-typescript-gen [--save --save-prefix=~]\n```\n\n```js\n// generate-protocol.js\nconst { generateProtocol } = require('@cldcvr/protobufjs-typescript-gen');\n\ngenerateProtocol({\n protocolDir: 'YOUR_PROTOCOL_DIRECTORY',\n outDir: 'YOUR_OUTPUT_DIRECTORY',\n});\n```\n\n```bash\n$> node generate-protocol.js\n```\n\n## Example\n\nPlease see the examples folder for the structure of the generated interface.\n","readmeFilename":"README.md"}