capacitor-segment

Originally forked from: https://github.com/joinflux/capacitor-segment

A Capacitor plugin for Segment analytics

Install

npm install @felix-health/capacitor-segment

and

npx cap sync

API

• initialize(...)
• identify(...)
• track(...)
• page(...)
• reset()

initialize(...)

initialize(options: InitializeOptions) => any

| Param | Type | | ------------- | ------------------------------------------------------------------------------------ | | options | { key: string; trackLifecycle?: boolean; recordScreenViews?: boolean; } |

Returns: any

identify(...)

identify(options: IdentifyOptions) => any

| Param | Type | | ------------- | -------------------------------------------------------- | | options | Identity & { traits?: any; options?: any; } |

Returns: any

track(...)

track(options: TrackOptions) => any

| Param | Type | | ------------- | ---------------------------------------------------- | | options | { eventName: string; properties: any; } |

Returns: any

page(...)

page(options: PageOptions) => any

| Param | Type | | ------------- | ---------------------------------- | | options | { pathname: string; } |

Returns: any

reset()

reset() => any

Returns: any

How to publish

1. Test your changes
2. Update the version in package.json, you can use npm version patch|minor|major.
3. Run npm run build to build the plugin.
4. Run npm publish --access public to publish the plugin to npm.

License

MIT License