0.0.7 • Published 17 days ago

epn-ref-manager v0.0.7

Weekly downloads
-
License
ISC
Repository
-
Last release
17 days ago

Logo

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

ПолеОписаниеТип
urlURL проектаstring;
SUBS_NAMEСписок поддерживаемых sub idstring[];
REF_PROGRAMS_SCHEMEНазвания реферальных программ{ [key: string]: string };
DEFAULT_REF_PROGRAMРеферальная программа для использования по умолчаниюstring;

COOKIES_OPTIONS

ПолеОписаниеТипПример
pathПуть, куда будут установлены cookiesstring;'/'
domainДомен, куда будут установлены cookiesstring;'domain.me'
expiresВремя жизни cookiesnumber;100500

Где взять подробную документацию?

  1. Перейдите в папку /docs
  2. Откройте index.html

Системные требования

  • Node.JS версии 14 и выше
  • yarn первой версии, последний стабильный релиз

Разработка

Изменения
  • Используйте yarn link или используйте yalc для связки модуля с проектом.
  • Если вы изменили методы, обновите jsdoc и запустите yarn docs
Сборка и тестирование
  • yarn build - Сборка production билда
  • yarn watch - Отсдеживание изменений кода и их сборка
  • yarn lint - Запуск eslint
  • yarn prettier - Запуск prettier
  • yarn test - Запуск unit тестов
0.0.7

17 days ago

0.0.6

3 months ago

0.0.5

3 months ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago