Git Product home page Git Product logo

eventsource-protobuf's Introduction

eventsource-protobuf

protoc plugin to generate eventsource.Serializers for github.com/altairsix/eventsource

Installation

go get github.com/vectorhacker/eventsource-protobuf/...

Usage

The simplest usage is to use eventsource-protobuf is along side your protoc go:generate line.

//go:generate protoc --go_out=. events.proto
//go:generate protoc --eventsource_out=. events.proto

Limitations

  • All events must be defined as protobuf messages
  • All events must be defined in a single .proto file
  • One message must be the container, effectively a union type with the following:
    • int32 type = 1;
    • Each event must be included in this message
  • Each event must the following fields defined:
    • string id - aggregate id
    • int32 version - version
    • int64 at - unix epoch in seconds

Example

The following provides a simple example of a .proto that adheres to all the stated requirements.

message ItemAdded {
    string id = 1;
    int32 version = 2;
    int64 at = 3;
}

message ItemRemoved {
    string id = 1;
    int32 version = 2;
    int64 at = 3;
}

// Events 
message Events {
    int32 type = 1;
    ItemAdded a = 2;
    ItemRemoved b = 3;
}

eventsource-protobuf's People

Contributors

savaki avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.