https://github.com/gamaops/protoschema

The coolest JSON Schema to Protobuf 3 definitions parser
https://github.com/gamaops/protoschema

json-schema parser protobuf protobufjs protocol-buffers validation validator

Last synced: 28 days ago
JSON representation

The coolest JSON Schema to Protobuf 3 definitions parser

• Host: GitHub
• URL: https://github.com/gamaops/protoschema
• Owner: gamaops
• License: mit
• Created: 2019-06-19T17:47:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:52:43.000Z (almost 2 years ago)
• Last Synced: 2024-11-14T16:47:47.468Z (about 1 month ago)
• Topics: json-schema, parser, protobuf, protobufjs, protocol-buffers, validation, validator
• Language: TypeScript
• Homepage:
• Size: 415 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# ProtoSchema

[![NPM](https://nodei.co/npm/protoschema.png)](https://nodei.co/npm/protoschema/)

![GitHub](https://img.shields.io/github/license/exocet-engineering/protoschema.svg)

![npm](https://img.shields.io/npm/dw/protoschema.svg)

![npm](https://img.shields.io/npm/v/protoschema.svg)

![npm type definitions](https://img.shields.io/npm/types/protoschema.svg)

ProtoSchema is the coolest JSON Schema 7 to Protobuf 3 definitions encoder.

* It's written in TypeScript and transpiled to Javascript

* The encoder is aware about messages references and will encode them when one is found in the picked schema to be encoded

* The encoded result is separated by namespaces

* You can use `null` on Protobuf 3 with the boolean field flag technique

* You can specify the byte length for numbers and integers

* It's unit tested to be bulletproof

* Zero dependency

```

npm install --save protoschema

```

## Guide

To learn quickly how to use the package go to the [guide](docs/GUIDE.md).

## API Reference

To understand more about the exported interface go to the [API reference](docs/API_REFERENCE.md).

## Contributing

See the [contributing guide](CONTRIBUTING.md) and the [code of conduct](CODE_OF_CONDUCT.md).

## License

This project is licensed under the MIT license.

Copyright © 2019 [codermarcos](https://github.com/codermarcos) and [vflopes](https://github.com/vflopes)