Skip to content

Commit

Permalink
fix typos in autoFixUndefinedEnumDefault
Browse files Browse the repository at this point in the history
  • Loading branch information
Zetazzz committed Jul 11, 2024
1 parent 251a735 commit b5cef4f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
<img height="20" src="https://github.com/cosmology-tech/telescope/actions/workflows/run-tests.yaml/badge.svg" />
</a>
<a href="https://github.com/cosmology-tech/lib-count">
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Ftotal.json"/>
</a>
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Ftotal.json"/>
</a>
<a href="https://github.com/cosmology-tech/lib-count">
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Fmonthly.json"/>
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Fmonthly.json"/>
</a>
<br />
<a href="https://github.com/cosmology-tech/telescope/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
Expand All @@ -23,7 +23,7 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/545047/178129981-5a7d18ed-d2b5-4d85-b828-ca084d38501e.png"/>
</p>

Telescope serves as the TypeScript Companion for CosmJS, used to generate developer-friendly TypeScript libraries for Cosmos blockchains. As a TypeScript transpiler for Cosmos Protobufs, akin to a "babel for the Cosmos", simply point to your protobuffer files and create full-typed libraries for teams to build dApps on your blockchain.

The following blockchain libraries (generated by Telescope) are available via npm
Expand Down Expand Up @@ -423,7 +423,7 @@ See [RPC Clients](#rpc-clients) for more info.
| `prototypes.typingsFormat.duration` | use either `duration` or `string` for `Duration` proto type | "duration"|
| `prototypes.typingsFormat.setDefaultEnumToUnrecognized` | false: enum empty value would be 0, true: -1(value for enum unrecognized) |true|
| `prototypes.typingsFormat.setDefaultCustomTypesToUndefined` | true: Timestamp,Duration,Any,Coin empty value would be undefined., false: using fromPartial to get an empty obj |false|
| `prototypes.typingsFormat.autoFixUndefinedEnumDefault` | the default value of an enum field would be: 1(proto2); 0(proto3); But in some rare cases, those default values are not existing. But enable this, default value will automatically fixed with the smallest value. |false|
| `prototypes.typingsFormat.autoFixUndefinedEnumDefault` | the default value of an enum field would be: 1(proto2); 0(proto3); But in some rare cases, those default values are not existing. By enabling this, the default value will be automatically fixed with the smallest value inside the enum. |false|

### Protobuf parser

Expand Down
10 changes: 5 additions & 5 deletions packages/telescope/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
<img height="20" src="https://github.com/cosmology-tech/telescope/actions/workflows/run-tests.yaml/badge.svg" />
</a>
<a href="https://github.com/cosmology-tech/lib-count">
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Ftotal.json"/>
</a>
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Ftotal.json"/>
</a>
<a href="https://github.com/cosmology-tech/lib-count">
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Fmonthly.json"/>
<img height="20" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.luolix.top%2Fcosmology-tech%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Ftelescope%2Fmonthly.json"/>
</a>
<br />
<a href="https://github.com/cosmology-tech/telescope/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
Expand All @@ -23,7 +23,7 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/545047/178129981-5a7d18ed-d2b5-4d85-b828-ca084d38501e.png"/>
</p>

Telescope serves as the TypeScript Companion for CosmJS, used to generate developer-friendly TypeScript libraries for Cosmos blockchains. As a TypeScript transpiler for Cosmos Protobufs, akin to a "babel for the Cosmos", simply point to your protobuffer files and create full-typed libraries for teams to build dApps on your blockchain.

The following blockchain libraries (generated by Telescope) are available via npm
Expand Down Expand Up @@ -423,7 +423,7 @@ See [RPC Clients](#rpc-clients) for more info.
| `prototypes.typingsFormat.duration` | use either `duration` or `string` for `Duration` proto type | "duration"|
| `prototypes.typingsFormat.setDefaultEnumToUnrecognized` | false: enum empty value would be 0, true: -1(value for enum unrecognized) |true|
| `prototypes.typingsFormat.setDefaultCustomTypesToUndefined` | true: Timestamp,Duration,Any,Coin empty value would be undefined., false: using fromPartial to get an empty obj |false|
| `prototypes.typingsFormat.autoFixUndefinedEnumDefault` | the default value of an enum field would be: 1(proto2); 0(proto3); But in some rare cases, those default values are not existing. But enable this, default value will automatically fixed with the smallest value. |false|
| `prototypes.typingsFormat.autoFixUndefinedEnumDefault` | the default value of an enum field would be: 1(proto2); 0(proto3); But in some rare cases, those default values are not existing. By enabling this, the default value will be automatically fixed with the smallest value inside the enum. |false|

### Protobuf parser

Expand Down

0 comments on commit b5cef4f

Please sign in to comment.