Typedoc json Angular parser

Парсит результат работы typedoc, формирует описание компонента, пригодное для вывода в интерфейсе, и записывает его в файл.

Установка:

npm install @ifelseapps/typedoc-json-angular-parser

Использование

const { parse } = require('@ifelseapps/typedoc-json-angular-parser');
const typeDocResult = require('docs.json');

parse(typeDocResult, { outputPath: '/some/path' });

Пример сгенерированного описания:

{
  "selector": "b-combobox",
  "api": {
    "inputs": [
      {
        "name": "items",
        "type": "Array<IItem>",
        "description": null
      },
      {
        "name": "placeholder",
        "type": "string",
        "description": null
      },
      {
        "name": "searchPlaceholder",
        "type": "string",
        "description": null
      },
      {
        "name": "width",
        "type": "string",
        "description": null
      }
    ],
    "outputs": [],
    "methods": []
  }
}

Особенности

• Для того, чтобы публичный метод попал в описание api компонента — ему нужно явно прописывать модификатор доступа public.