0.1.3 • Published 4 years ago
@kleriotech/web-sdk v0.1.3
klerio web sdk
Usage
npm i @kleriotech/web-sdk
<script src="klerio.umd.development.js"></script>
<script>
Klerio.init();
Klerio.collect('event_name', { data: 1 });
Klerio.setUserId('user-1');
Klerio.collectUserProperties('user_event', { email: 'test@mail.com' });
</script>
API
.init(options?)
Initializes the sdk
options
Type: object
enableBackup
Type: boolean
Default: false
Events are stored in localStorage as backup, events which are sent are cleared.
.collect(name, properties)
registers an event
name
Type: string
Event name
properties
Type: object
Event properties
.collectUserProperties(name, properties)
registers an user event
name
Type: string
Event name
properties
Type: object
Event properties
.setUserId(id)
Sets an custom user id
id
Type: string
User ID
.enableGeo()
Enable geo data collection