❤
npm
Sign UpSign In

lytics-js

0.0.59 • Public • Published

Installation

#global package installation (recommended if you are new to npm packages) 
npm install lytics-js -g
 
#local package installation 
npm install lytics-js 

Usage

JavaScript

You can use this package in order to write applications that use the Lytics API.

var lytics = require('lytics-js');
var client = lytics.getClient('[apikey]');
//
//get an array of account objects
var accounts = await client.getAccounts();
//
//test a query function
var is_true = await client.testFunction('tobool', ['1']);
var is_false = await client.testFunction('tobool', ['f']);
var is_undefined = await client.testFunction('email', ['something that isn\'t an email']);
var is_email = await client.testFunction('email', ['test@email.com']);

Command-line interface (CLI)

This package includes a command-line interface (CLI) for Lytics. The CLI is available as an executable included in the package. You can run the CLI by installing the package locally or globally.

Display help

#local package 
$(npm bin)/lytics-js help
 
#global package 
lytics-js help

Lytics watch

#to use the Lytics API key set in the environment variable LIOKEY 
lytics-js watch .
 
#to pass the Lytics API key directly 
lytics-js -k [apikey] watch .

Test query function

#to use the Lytics API key set in the environment variable LIOKEY 
lytics-js function contains "something really interesting" "really"
 
#to pass the Lytics API key directly 
lytics-js -k [apikey] function tobool 1
 
#passing multiple parameters 
lytics-js function contains "something really interesting" "really"
 
#passing no parameters 
lytics-js function now

User field whitelisting

#list user fields currently whitelisted 
lytics-js whitelist -a [Lytics account ID] list
 
#add a field to the whitelist 
lytics-js whitelist -a [Lytics account ID] add email
 
#remove a field from the whitelist 
lytics-js whitelist -a [Lytics account ID] remove email

Readme

Keywords

none

Package Sidebar

Install

npm i lytics-js

Repository

github.com/lytics/lytics-js

Homepage

github.com/lytics/lytics-js#readme

Weekly Downloads

5

Version

0.0.59

License

ISC

Unpacked Size

306 kB

Total Files

45

Last publish

Collaborators

  • adam.conn
  • markhayden
Try on RunKit
Report malware