dgeni-packages - npm Package Versions

0.26.0 2 March 2018

Features

• typescript:

• add isAbstract properties to classes and members 315b6ceb
• use TypeScript v2.7 to parse the TS source files 85ffe3a0

BREAKING CHANGES:

The new version of TypeScript has better handling for specially named members such as __constructor and __call. To support this the TypeScript API introduced a new type __String for holding escaped versions of these strings.

This makes is much safer in case a member name collided, but it also introduces a breaking change to the TypeScript AST public interface.

This will not affect developers using the typescript package unless they are trying to interact with the TS AST directly, or they were expected to interact with escaped forms of special names, such as __esModule, which is ___esModule in its escaped form.

0.25.0 28 February 2018

Fixes

• typescript:
  • remove namespacesToInclude feature 6a893df3
  • give path and outputPath initial values c5f3049f

Breaking Change

The namespacesToInclude service has been removed from the package. Now when rendering types full qualified names are always rendered and no namespaces are stripped.

If you relied on this then you should implement a processor to search for these rendered types and strip them.

0.24.3 25 February 2018

Features

• typescript: expose defaultValue information on ParameterDocs ba8f57fa

0.24.2 24 Febrary 2018

Features

• typescript:
  • expose isOptional information on ParameterDocs 39ad2feb
  • create BaseApiDoc class 9586f881

Fixes

• typescript:
  • ParameterDoc is a type of BaseApiDoc, not ExportDoc d00b3ed2
  • only use unix style line endings when rendering code ef1f83c9

0.24.1 7 February 2018

Fixes

• jsdoc: braces in the description are not jsdoc types 35763aafa
• typescript: fallback to decorators from set accessor 3a4e56855
• jsdoc: handle import statements in code name matching 5db8fc90f

0.24.0 26 January 2018

Fixes

• typescript: align default path and id templates 0ff52e2b
• typescript: do not encode anchors for member API docs 7cad9780
• base: checkAnchorLinksProcessor now copes with encoded chars f7f6f589

BREAKING CHANGE

Anchors to member API docs, whch are accessed via doc.anchor are no longer URL encoded. You should do this in your template if that is required.

• Before: <a href="{$ doc.anchor $}">...</a>
• After: <a href="{$ doc.anchor | urlencode $}">...</a>

0.23.0 17 January 2018

Fixes

• typescript:
  • show proper name for aliased exports f7034143

Features

• jsdoc:
  • improve support for named exports in the codeName service 45c28b61
• typescript:
  • merge @param descriptions into ParameterDocs af7f5213
  • process parameters as docs 4d04d8f9
  • move helpers to ModuleDoc to simplify API doc constructors a776355c

BREAKING CHANGE

The constructor signatures for API API docs have changed. You no longer need to pass the basePath, namespacesToInclude or typeChecker to any API doc constructor except for the ModuleDoc. All API docs now get hold of these values from their containing ModuleDoc.

Generally this should not affect users of dgeni-packages since it is not expected that API doc classes should be instantiated directly.

0.22.1 23 November 2017

Fixes

• typescript: remove comments from re-rendered code 0be17b9a

0.22.0 9 October 2017

Fixes

• typescript: handle property accessors correctly f72b69e5f

BREAKING CHANGE

To support the handling of get and set accessors, there are new docTypes "get-accessor-info" and "set-accessor-info", which need templates.

0.21.6 9 October 2017

Reverts

• typescript: handle property accessors correctly a4be78add

This change introduced a breaking change, which is that there are new docTypes "get-accessor-info" and "set-accessor-info", which need templates.