Функция документа, которая возвращает свойство объекта по параметру - PullRequest
0 голосов
/ 31 декабря 2018

Я делаю Api-репозиторий для моего приложения Vue.js, следуя этой статье .

Дело в том, что мне нравится документировать свои функции, чтобы у меня было лучшее завершение кода на VSCode,Я обычно использую jsDoc для этого.

Я застрял здесь:

import DiarioEscolarRepository from './diarioEscolarRepository';
import PeriodoAvaliativoRepository from './periodoAvaliativoRepository';
import AtividadeAvaliativaRepository from './atividadeAvaliativaRepository';
import CorteEtarioRepository from './corteEtarioRepository';

const repositories = {
  diarioEscolar: DiarioEscolarRepository,
  periodoAvaliativo: PeriodoAvaliativoRepository,
  atividadeAvaliativa: AtividadeAvaliativaRepository,
  corteEtario: CorteEtarioRepository,
};

export default const RepositoryFactory = {
  get(name){
    return repositories[name];
  }
};

Мне нужно сделать так, чтобы редактор понимал, что функция get является простым наследником объекта репозиториев.

Iпробовал использовать @typedef и @type, но ни один из них не работал должным образом.

Я пробовал что-то вроде @returns {repositories.name}, но также не работает.

Есть ли способ документироватьэто?

Я тоже думал об использовании файла определения машинописного текста, но никогда не делал этого, поэтому не знаю, с чего начать.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...