Pickle for Node.js

Node.js package for Pickle analytics.

Install

npm i @souranalytics/node

import { Pickle } from '@souranalytics/node'
 
const pickle = new Pickle(options)

Option	Type	Description	Required	Default
`options.apiKey`	`string`	Project API key	Yes	-
`options.url`	`string`	Override Pickle API endpoint	No	`https://pickle.sh`
`options.anonymousId`	`string`	Override anonymous user id	No	`cuid2`

pickle.identify(user: UserProps, data?: UserProps): Promise<void>

Option	Type	Description	Required
`user.id`	`string`	User id	Yes
`user.name`	`string`	User name	No
`user.email`	`string`	User email	No
`data`	`object`	User properties	No

pickle.event(name: string, data?: EventProps): Promise<void>

Option	Type	Description	Required
`name`	`string`	Event name	Yes
`data`	`object`	Event properties	No

pickle.view(name: string, data?: ViewProps): Promise<void>

Option	Type	Description	Required
`name`	`string`	View name	Yes
`data`	`object`	View properties	No