search

flitbit / json-ptr

A complete implementation of JSON Pointer (RFC 6901) for nodejs and modern browsers.
MIT License
91 stars 28 forks source link

Undocumented exported functions? #29

Closed kevinoid closed 3 years ago

kevinoid commented 3 years ago

The functions defined in src/util.ts are exported, but are not mentioned in README.md and only their signatures are documented by TypeDoc. Could you clarify whether these are intended to be part of the public API?

Thanks, Kevin

cerebralkungfu commented 3 years ago

They are indeed, purposefully exported, as part of the intended public API so that other utilities might be built on them if they are useful. Those are the guts really... the classes make use of those utility functions and the tests cover them many times over. That said, I really should get them documented and explained as time permits.