[suggestion] chore: add annotation typescript usage in README

[bananaumai]

About

recommend enabling strict mode for avoiding type checking failure when using this library in TypeScript project.

Background

As I mentioned in #135 , I found the circumstance where the type checking for encode/decode function call fails.

That specifically happens when user defined context type is given to the ExtensionCodec.

const extensionCodec = new ExtensionCodec<UserDefinedContext>();

Solution

Set compilerOptions.strictNullChecks to true in tsconfig.json.

Acknowledgement

I'm not so familiar with TypeScript and still don't understand why this issue happens. (I'll follow up this phenomenon for my interest later)

[codecov-commenter]

Codecov Report

Merging #136 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #136   +/-   ##
=======================================
  Coverage   98.29%   98.29%           
=======================================
  Files          15       15           
  Lines         936      936           
  Branches      205      205           
=======================================
  Hits          920      920           
  Misses         16       16           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ed7993...0709254. Read the comment docs.

[gfx]

Nice catch!

I'm not sure why strictNullChecks to compile, neither. Hopefully, this library works without strictNullChecks, but this explanation should help users for the time being.