Fix test cases and docs

[ryanio]

This PR:

• Updates typedoc of baseTrie get and put to match its type definition (only Buffer).
• Updates typedoc dep to next to utilize library mode.
• Updates test cases from strings to buffers for trie keys and values.
• Updates travis node 6 runner to node 12.
• Matches default style of badges.

[holgerd77]

@ryanio Thanks for the PR! If you later on add such significant changes like updating the Node versions in the test setup, please remember to update the PR title as well. Stuff like this is otherwise too likely to be overlooked when writing up release notes.

Will mention @s1na for cc here.

[s1na]

Hey yeah Ryan wrote me. I think we can update the tests to use buffers explicitly as Ryan himself suggests.

[coveralls]

Coverage increased (+0.05%) to 93.015% when pulling b2c6fe9 on fixReadme into d48a38c on master.

[ryanio]

Thanks @s1na, I have updated the typedoc and test cases, please take a look and let me know if it looks good 🙂

[s1na]

So I see quite a few items here that I don't think should be public and documenting them might give the impression they are public. We're exporting them from the individual files so that other files can use, but ideally only the things re-exported in index.ts should be considered public. I don't remember exactly if typedoc supported something like this, I remember I had struggled with this before..

[ryanio]

Gotcha, thanks. In ethereumjs-util I discovered typedoc@next has a library mode (TypeStrong/typedoc#639) that is quite neat. I gave it a try here with some additional exclude params and seems like it's working well. I just pushed a commit if you would like to take a look.

[s1na]

Skimmed through. Looks good, thanks Ryan! It seems the private attributes of the classes are still documented even though you specifiec excludePrivate (maybe we'll have to add a @private or something typedoc can detect). But this can be done in future. I'm not even sure if we're excluding these private stuff in other libraries.

[s1na]

I love these test cases lol

[s1na]

Hm not sure I like this linting rule, but doesn't matter..

[s1na]

I hope they do add a feature to automatically detect public API so we don't have to exclude by file name

[ryanio]

Yeah I agree, the library mode is a great first step so hopefully we'll see more in the future in that direction.

[holgerd77]

👍

@s1na thanks for settling this out!