near / borsh-js

TypeScript/JavaScript implementation of Binary Object Representation Serializer for Hashing
Apache License 2.0
112 stars 38 forks source link

Documentation says nothing about Test object and where it came from. #42

Closed dmitryr117 closed 10 months ago

dmitryr117 commented 2 years ago

Need more documentation for Test object. Otherwise unclear what it is and how it should be defined.

 const value = new Test(

 { x: 255, y: 20, z: '123', q: [1, 2, 3] } 

);

What is Test? What is its definition?

marcus-pousette commented 2 years ago

Read the top of this test file https://github.com/near/borsh-js/blob/master/borsh-ts/test/serialize.test.js

samlaf commented 2 years ago

I agree that the Test object should be defined in the docs... or at least that serialize.test.js should be linked.

gagdiez commented 10 months ago

should be fixed now, please open again if not