@protobuf-ts/runtime-angular

Runtime library for using the protoc plugin "protobuf-ts" with Angular

Usage no npm install needed!

<script type="module">
  import protobufTsRuntimeAngular from 'https://cdn.skypack.dev/@protobuf-ts/runtime-angular';
</script>

README

@protobuf-ts/runtime-angular

Runtime library for using protobuf-ts with Angular.

Installation:

npm i @protobuf-ts/runtime @protobuf-ts/runtime-rpc @protobuf-ts/runtime-angular @protobuf-ts/twirp-transport

You probably want the protoc plugin as well:

npm i -D @protobuf-ts/plugin

Usage:

  • generate code
    npx protoc --ts_opt enable_angular_annotations --ts_out src/ my-message.proto
    
  • import the PbDatePipeModule to get the date pipe that works with google.protobuf.Timestamp or google.type.DateTime
  • import TwirpModule.forRoot() to get a Twirp transport that uses the Angular HttpClient

To learn more, please read the MANUAL or check the repository README for a quick overview.

Building this project

This project was generated with Angular CLI version 10.0.5.

To work with lerna, package.json has the publishConfig.directory set to ./dist/ and the lifecycle script scripts.version bumps the versions of peerDependencies and updates dist/package.jsons.