Declares types for typescript

[dvc94ch]

No description provided.

[codecov-io]

Codecov Report

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

@@           Coverage Diff           @@
##           master       #2   +/-   ##
=======================================
  Coverage   99.54%   99.54%           
=======================================
  Files           1        1           
  Lines         222      222           
=======================================
  Hits          221      221           
  Misses          1        1

---

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 a216d6f...7181b06. Read the comment docs.

[polytypic]

Hmm... I'm not intimately familiar with TypeScript, but given TypeScript's use of structural typing, doesn't this mean that any object is seen as a valid document? IOW, given this definition, does e.g. render(0, {foo: 'bar'}) give a type error (it probably should, because it is an error)?

[polytypic]

Thanks! This looks basically good, but the definition

interface IDoc {}

seems suspicious to me, because to me it looks like any object would then be accepted as a document, which should not be the case — assuming one actually wants some amount of type safety. I'm not intimately familiar with TypeScript, however, so I might be missing something.

[polytypic]

Perhaps a definition like this would be a good enough approximation:

type IDoc = string | IDocArray
interface IDocArray extends Array<IDoc> { }

This should allow one to pass strings and arrays of documents as documents, but not arbitrary objects or numbers, for example. Of course, there are also other kinds of documents, but one should generally treat documents as abstract and never manipulate them except by using the functions from the library.

[dvc94ch]

assuming one actually wants some amount of type safety

type IDoc = string | IDocArray
interface IDocArray extends Array<IDoc> { }

Much better, thank you. Updated it with your suggestion. Also helps with documentation and text editor support.

[polytypic]

Looks good. I'll try to find time to merge this and release a new version with the typings this evening. Thanks again for the PR!