v1.1.0

#62 Typescript 2.7.1 support through Typedoc 0.10.0 🎆

v1.0.0

Same as v1.0.0-beta.4, just stabilizing the version.

v1.0.0-beta.4

TypescriptPlugin

• #59 objects (classes & interfaces) now expose indexSignature property, if defined.
• #60 new sourceUrl field on all entries links to entry definition line in file in repository (typically on github.com) at current commit (or on specified branch via new gitBranch option).

v1.0.0-beta.3

🔥 this release failed, see 1.0.0-beta.4

v1.0.0-beta.2

TypescriptPlugin

• #58 add tsconfigPath and verbose options

v1.0.0-beta.1

Typescript Plugin

• #56 🔥 client symbols can only be imported from documentalist/dist/client.
• #56 🔥 Kind.Parameter ⇒ Kind.MethodParameter, Kind.Signature ⇒ Kind.MethodSignature.
  • both of these kinds are only used inside a Kind.Method, so they've been renamed accordingly.
• #56 add new linkify utility function to render links to known symbols within a text string,
• #57 🔥 excludePaths option works identically to excludeNames now: Array<string | RegExp> patterns, not glob.

v1.0.0-beta.0

New Features

Typescript Plugin

• added extends (#45) and implements (#49) fields to classes and interfaces.
• added inheritedFrom (#45) field to methods and properties (inverse of extends).
• added constructorType (#49) to classes for constructor signatures.
• include type parameters in type strings
• document enum members and type alias members #53

Documentation

• improved usage docs.
• known members mentioned in types can be clicked upon to jump straight to their docs!
• left nav scrolls separately from content.

v0.1.1

• fix publishing

v0.1.0

• rewrite TypescriptPlugin to use typedoc for documentation extraction
  • typedoc currently requires [email protected], which is much better than the previous requirement of [email protected].
  • 🔥 data is now in the typescript key, instead of ts.
  • 🔥 data format is very similar to previous iteration, but some fields have been renamed.
    • flags object contains isDeprecated, isOptional, etc.

v0.0.8

Add typedoc data to documentalist json. This enables much deeper description of all typescript types including interfaces, classes, consts, type aliases, etc.