This commit is contained in:
49
node_modules/resolve-protobuf-schema/README.md
generated
vendored
Normal file
49
node_modules/resolve-protobuf-schema/README.md
generated
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
# resolve-protobuf-schema
|
||||
|
||||
Read a protobuf schema from the disk, parse it and resolve all imports
|
||||
|
||||
```
|
||||
npm install resolve-protobuf-schema
|
||||
```
|
||||
|
||||
[](http://travis-ci.org/mafintosh/resolve-protobuf-schema)
|
||||
|
||||
## Usage
|
||||
|
||||
Store the following example protobuf schema in `test.proto`
|
||||
|
||||
```
|
||||
message Test {
|
||||
optional string test = 1;
|
||||
}
|
||||
```
|
||||
|
||||
Then run
|
||||
|
||||
``` js
|
||||
var resolve = require('resolve-protobuf-schema')
|
||||
console.log(resolve.sync('test.proto')) // prints the parsed schema
|
||||
```
|
||||
|
||||
Schema imports will resolved as well
|
||||
|
||||
```
|
||||
import "./test.proto"
|
||||
|
||||
message AnotherTest {
|
||||
optional string test = 1;
|
||||
}
|
||||
```
|
||||
|
||||
``` js
|
||||
console.log(resolve.sync('./another-test.proto')) // will print a combined parsed schema
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
* `resolve(path, cb)` read and resolve a schema
|
||||
* `resolve.sync(path)` sync version of `resolve`
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user