Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

access-data-parser

derevandal2.2kMIT1.5.1TypeScript support: included

This module will receive document.referrer and some query params to determine where access come from.

access, data, parser, query, params, document, referrer, referral, access, type, access, paid, access, organic

readme

Access Data Parser

GitHub issues GitHub stars All Contributors npm version npm downloads renovate enabled Travis (.org) branch Requirements Status GitHub license FOSSA Status

This module will receive document.referrer and some query params to determine where access come from.

Install

pnpm add access-data-parser

Usage

import AccessData from 'access-data-parser'

const queriesFromBrowser = {
  utm_source: "",
  utm_medium: "",
  utm_campaign: "",
  utm_content: "",
  utm_term: "",
  referrer: "https://google.com/"
};

console.log(new AccessData(queriesFromBrowser));
/* expected:
 {
   source: 'google',
   medium: 'organic',
   referrer: 'https://google.com/',
   channel: 'organic'
 }
*/

Params Supported

  • source
  • medium
  • campaign
  • content
  • term
  • referrer
  • fbclid
  • gclid

Default Channels

  • direct
  • organic
  • social
  • paid
  • display
  • referral

Contributing

PRs accepted.

License

MIT © ANDRÉ VAN DAL

Contributors ✨

Thanks goes to these wonderful people (emoji key):

André Van Dal
André Van Dal

🚇 🚧 ⚠️ 💻

This project follows the all-contributors specification. Contributions of any kind welcome!