Leszek Wiesner 0804bfbb34 Fix checks - remove StorageProviderRecord and run formatter on protobuf library | 3 سال پیش | |
---|---|---|
.. | ||
compiled | 3 سال پیش | |
doc | 3 سال پیش | |
proto | 3 سال پیش | |
src | 3 سال پیش | |
test | 3 سال پیش | |
.eslintignore | 3 سال پیش | |
.eslintrc.js | 3 سال پیش | |
.gitignore | 3 سال پیش | |
.prettierignore | 3 سال پیش | |
README.md | 3 سال پیش | |
compile.sh | 3 سال پیش | |
doc-appendix.md | 3 سال پیش | |
generate-md-doc.sh | 3 سال پیش | |
package.json | 3 سال پیش | |
tsconfig.json | 3 سال پیش |
This package contains protobuf message definitions compiled to Javascript/Typescript used for creating and updating various metadata blobs in the joystream content directory.
Documented in doc folder
For our usecase we wish to re-use same message to create and update subset of fields. For this reason we need the explicit information about wether a field has been set or not and this is only possible with proto v2.
Background: required/optional feilds are deprecated in proto v3
The custom Joystream types such as License have helper methods to construct pre-defined well known values.
Best place to look at are the tests specs
We use simple ISO_639-1 code representation for Language. useful npm package https://www.npmjs.com/package/iso-639-1
Building will compile the protofiles and build the library from source.
pre-requisists for compiling protofiles:
pre-requisists for generating documentation:
protoc-gen-doc to generate docs
yarn && yarn build
yarn generate-docs
yarn test