0.0.7 • Published 17 days ago
epn-ref-manager v0.0.7
Ref manager
Модуль для получения и установки рефереальных параметров из url, sessionStorage или cookies.
Как начать работать?
import RefManager from 'epn-ref-manager';
const CONFIG = {
url: 'epn.bz',
SUBS_NAME: ['sub', 'sub2', 'sub3', 'sub4', 'sub5'],
REF_PROGRAMS_SCHEME: {
'some-name': 'some-value',
},
DEFAULT_REF_PROGRAM: 'some-default-value',
};
const COOKIES_OPTIONS = {
path: '/',
domain: 'domain.me',
expires: 100500,
};
const refManager = new RefManager(CONFIG, COOKIES_OPTIONS);
await refManager.getClickID();
Описание полей
CONFIG
Поле | Описание | Тип |
---|---|---|
url | URL проекта | string; |
SUBS_NAME | Список поддерживаемых sub id | string[]; |
REF_PROGRAMS_SCHEME | Названия реферальных программ | { [key: string]: string }; |
DEFAULT_REF_PROGRAM | Реферальная программа для использования по умолчанию | string; |
COOKIES_OPTIONS
Поле | Описание | Тип | Пример |
---|---|---|---|
path | Путь, куда будут установлены cookies | string; | '/' |
domain | Домен, куда будут установлены cookies | string; | 'domain.me' |
expires | Время жизни cookies | number; | 100500 |
Где взять подробную документацию?
- Перейдите в папку /docs
- Откройте index.html
Системные требования
- Node.JS версии 14 и выше
- yarn первой версии, последний стабильный релиз
Разработка
Изменения
- Используйте
yarn link
или используйте yalc для связки модуля с проектом. - Если вы изменили методы, обновите jsdoc и запустите yarn docs
Сборка и тестирование
yarn build
- Сборка production билдаyarn watch
- Отсдеживание изменений кода и их сборкаyarn lint
- Запуск eslintyarn prettier
- Запуск prettieryarn test
- Запуск unit тестов