corymickelson / NoPoDoFo

node pdf native bindings
GNU Affero General Public License v3.0
26 stars 6 forks source link

Document library #74

Closed corymickelson closed 6 years ago

corymickelson commented 6 years ago

The lib (ts) interface needs to be documented. Naming conventions, and what it means when something returns an NPDFInternal type. What the "I" means, and how to use enum types, and generics such as Callback.

Should this be extracted to just a typings file? Should a higher level javascript interface be implemented on top ( or with the help of ) the internal interface? Should the internal interface just be documented well enough for others to implement higher level libraries?