optimax-flow-types v1.0.1

Контракты

Как создать новый контракт

1. В папке definitions создаем новую папку для вашего апи (если требуется). Структура папок пока не определена. Файл называем index.js. В самом начале файла не забываем написать // @flow.
2. Указываем в корневом файле index.js путь до вашего файла. Пример:

export * from './definitions/quote';

3. Увеличить версию в файле package.json (чтобы мы смогли опубликовать новую версию контракта).

"version": "1.0.0", => "version": "1.0.1",

4. Создать ПР, собрать фронтовые и бекендные апрувы.
5. Сообщить тимлиду, чтобы он опубликовал новую версию контрактов в npm.
6. Готово. 🔥

Договоренности

1. Название должно быть CamelCase.
2. Название должно включать Response или Payload (в зависимости от того что это).
3. В конце дописываем Type.
4. Если создаем новый тип, то создаем и фикстуру для нее.

Пример:

// flow types
export CartPayloadType = {};
export CartResponseType = {};
// fixture
export CartPayloadFixture: CartPayloadType = {};
export CartResponseFixture: CartResponseType = {};

Полезное

Полная документация по написанию типов https://flow.org/en/docs/types/