intelligencer v0.2.0

Intelligencer 🕵

Behavioral targeting library that helps you to take action based on user activities.

Status

The library is in the development phase, not yet ready for production use.

Installation

The library supports all the popular installation methods:

Using CDN

<script src="https://unpkg.com/intelligencer/dist/intelligencer.umd.min.js"></script>
<script>
  // For usage details, look at the Usage section in this documentation
  new intelligencer({}).execute(() => {})
</script>

Webpack/Rollup/NPM/Yarn Etc.

# Install the package first:
npm i intelligencer
# or
yarn add intelligencer

import intelligencer from 'intelligencer'

// For usage details, look at the Usage section in this documentation
new intelligencer({}).execute(() => {})

Usage

Intelligencer needs two things to get started.

1. The IntelligencerConfiguration which contains the targeting details.
2. The function you want to execute when the conditions are met.

And the signature is like that:

new intelligencer(myConfig: IntelligencerConfiguration)
    .execute(myFunction: () => void)

There is a lot of targeting options you can set in the configuration object. To make life easier, we have a Intelligencer configuration generator website. Just go to the website, pick whatever you want, copy your configuration and paste it into your code.

For eye familiarity, you will probably have something like that:

new intelligencer({
  name: 'MyIntelligencer',
  frequency: {
    maxExecutionCount: 2,
    durationBetweenExecutions: 600,
  },
  onExitIntent: true,
}).execute(() => {
  alert('Hello world!')
})

License

MIT