From b5a0785ed06f99639090f730fb854312ea6dc5da Mon Sep 17 00:00:00 2001 From: Jack Keene Date: Mon, 27 Nov 2023 13:22:15 +0000 Subject: [PATCH] Remove old docs folder --- .../docs/browser-tracker.api.md | 391 ------------------ .../browser-tracker.activitycallback.md | 13 - .../browser-tracker.activitycallbackdata.md | 20 - ...itytrackingconfiguration.heartbeatdelay.md | 13 - ...r-tracker.activitytrackingconfiguration.md | 21 - ...rackingconfiguration.minimumvisitlength.md | 13 - ...ytrackingconfigurationcallback.callback.md | 13 - ...r.activitytrackingconfigurationcallback.md | 20 - .../browser-tracker.addglobalcontexts.md | 25 -- .../markdown/browser-tracker.addplugin.md | 25 -- ...rowser-tracker.anonymoustrackingoptions.md | 14 - ...ker.browserplugin.activatebrowserplugin.md | 18 - .../markdown/browser-tracker.browserplugin.md | 21 - ...wser-tracker.browserpluginconfiguration.md | 21 - ...acker.browserpluginconfiguration.plugin.md | 11 - ...rowser-tracker.browsertracker.addplugin.md | 13 - ...er-tracker.browsertracker.clearuserdata.md | 13 - .../browser-tracker.browsertracker.core.md | 13 - ...racker.browsertracker.crossdomainlinker.md | 13 - ....browsertracker.disableactivitytracking.md | 13 - ...tracker.disableactivitytrackingcallback.md | 13 - ...browsertracker.disableanonymoustracking.md | 13 - ...ser-tracker.browsertracker.discardbrace.md | 13 - ...r-tracker.browsertracker.discardhashtag.md | 13 - ...r.browsertracker.enableactivitytracking.md | 13 - ...rtracker.enableactivitytrackingcallback.md | 13 - ....browsertracker.enableanonymoustracking.md | 13 - ...wser-tracker.browsertracker.flushbuffer.md | 13 - ...er-tracker.browsertracker.getcookiename.md | 13 - ...er.browsertracker.getdomainsessionindex.md | 13 - ...-tracker.browsertracker.getdomainuserid.md | 13 - ...racker.browsertracker.getdomainuserinfo.md | 13 - ...er-tracker.browsertracker.getpageviewid.md | 13 - ...browser-tracker.browsertracker.gettabid.md | 13 - ...rowser-tracker.browsertracker.getuserid.md | 13 - .../browser-tracker.browsertracker.id.md | 13 - .../browser-tracker.browsertracker.md | 58 --- ...rowser-tracker.browsertracker.namespace.md | 13 - ...owser-tracker.browsertracker.newsession.md | 13 - ...acker.browsertracker.preservepageviewid.md | 13 - ...er-tracker.browsertracker.setbuffersize.md | 13 - ...-tracker.browsertracker.setcollectorurl.md | 13 - ...er-tracker.browsertracker.setcookiepath.md | 13 - ...ser-tracker.browsertracker.setcustomurl.md | 13 - ...tracker.browsertracker.setdocumenttitle.md | 13 - ...-tracker.browsertracker.setoptoutcookie.md | 13 - ...r-tracker.browsertracker.setreferrerurl.md | 13 - ...rowser-tracker.browsertracker.setuserid.md | 13 - ...cker.browsertracker.setuseridfromcookie.md | 13 - ...er.browsertracker.setuseridfromlocation.md | 13 - ...er.browsertracker.setuseridfromreferrer.md | 13 - ....browsertracker.setvisitorcookietimeout.md | 13 - ...wser-tracker.browsertracker.sharedstate.md | 13 - ...er-tracker.browsertracker.trackpageview.md | 13 - ...acker.browsertracker.updatepageactivity.md | 13 - .../browser-tracker.builtincontexts.md | 18 - .../browser-tracker.clearglobalcontexts.md | 24 -- .../markdown/browser-tracker.clearuserdata.md | 25 -- ...wser-tracker.clearuserdataconfiguration.md | 21 - ...aruserdataconfiguration.preservesession.md | 11 - ...clearuserdataconfiguration.preserveuser.md | 11 - ...rowser-tracker.clientsession.eventindex.md | 13 - ...wser-tracker.clientsession.firsteventid.md | 13 - ...acker.clientsession.firsteventtimestamp.md | 13 - .../markdown/browser-tracker.clientsession.md | 28 -- ...tracker.clientsession.previoussessionid.md | 13 - ...browser-tracker.clientsession.sessionid.md | 13 - ...wser-tracker.clientsession.sessionindex.md | 13 - ...-tracker.clientsession.storagemechanism.md | 13 - .../browser-tracker.clientsession.userid.md | 13 - ...r-tracker.commoneventproperties.context.md | 13 - .../browser-tracker.commoneventproperties.md | 21 - ...tracker.commoneventproperties.timestamp.md | 13 - ...wser-tracker.conditionalcontextprovider.md | 13 - .../browser-tracker.contextevent.event.md | 13 - ...rowser-tracker.contextevent.eventschema.md | 18 - .../browser-tracker.contextevent.eventtype.md | 18 - .../markdown/browser-tracker.contextevent.md | 22 - .../markdown/browser-tracker.contextfilter.md | 13 - .../browser-tracker.contextgenerator.md | 13 - .../browser-tracker.contextprimitive.md | 13 - .../browser-tracker.cookiesamesite.md | 11 - .../browser-tracker.crossdomainlinker.md | 25 -- ...browser-tracker.disableactivitytracking.md | 24 -- ...tracker.disableactivitytrackingcallback.md | 24 -- ...rowser-tracker.disableanonymoustracking.md | 25 -- ...r.disableanonymoustrackingconfiguration.md | 20 - ...ckingconfiguration.statestoragestrategy.md | 11 - .../markdown/browser-tracker.discardbrace.md | 25 -- .../browser-tracker.discardhashtag.md | 25 -- .../browser-tracker.enableactivitytracking.md | 25 -- ...-tracker.enableactivitytrackingcallback.md | 25 -- ...browser-tracker.enableanonymoustracking.md | 25 -- ...er.enableanonymoustrackingconfiguration.md | 21 - ...eanonymoustrackingconfiguration.options.md | 11 - ...ckingconfiguration.statestoragestrategy.md | 11 - .../markdown/browser-tracker.eventmethod.md | 11 - .../browser-tracker.filterprovider.md | 16 - .../markdown/browser-tracker.flushbuffer.md | 25 -- ...rowser-tracker.flushbufferconfiguration.md | 20 - ....flushbufferconfiguration.newbuffersize.md | 11 - .../docs/markdown/browser-tracker.md | 94 ----- .../markdown/browser-tracker.newsession.md | 24 -- .../markdown/browser-tracker.newtracker.md | 25 -- .../markdown/browser-tracker.newtracker_1.md | 26 -- ...r-tracker.pageviewevent.contextcallback.md | 13 - .../markdown/browser-tracker.pageviewevent.md | 21 - .../browser-tracker.pageviewevent.title.md | 13 - .../docs/markdown/browser-tracker.platform.md | 11 - .../browser-tracker.preservepageviewid.md | 24 -- .../browser-tracker.removeglobalcontexts.md | 25 -- .../browser-tracker.ruleset.accept.md | 11 - .../docs/markdown/browser-tracker.ruleset.md | 21 - .../browser-tracker.ruleset.reject.md | 11 - .../browser-tracker.rulesetprovider.md | 16 - ...owser-tracker.selfdescribingevent.event.md | 13 - .../browser-tracker.selfdescribingevent.md | 20 - .../browser-tracker.selfdescribingjson.md | 16 - .../markdown/browser-tracker.setbuffersize.md | 25 -- .../browser-tracker.setcollectorurl.md | 25 -- .../markdown/browser-tracker.setcookiepath.md | 25 -- .../markdown/browser-tracker.setcustomurl.md | 25 -- .../browser-tracker.setdocumenttitle.md | 25 -- .../browser-tracker.setoptoutcookie.md | 25 -- .../browser-tracker.setreferrerurl.md | 25 -- .../markdown/browser-tracker.setuserid.md | 25 -- .../browser-tracker.setuseridfromcookie.md | 25 -- .../browser-tracker.setuseridfromlocation.md | 25 -- .../browser-tracker.setuseridfromreferrer.md | 25 -- ...browser-tracker.setvisitorcookietimeout.md | 25 -- .../browser-tracker.statestoragestrategy.md | 11 - .../browser-tracker.structuredevent.action.md | 11 - ...rowser-tracker.structuredevent.category.md | 11 - .../browser-tracker.structuredevent.label.md | 11 - .../browser-tracker.structuredevent.md | 24 -- ...rowser-tracker.structuredevent.property.md | 11 - .../browser-tracker.structuredevent.value.md | 11 - .../browser-tracker.trackerconfiguration.md | 59 --- .../markdown/browser-tracker.trackpageview.md | 25 -- ...rowser-tracker.trackselfdescribingevent.md | 25 -- .../browser-tracker.trackstructevent.md | 25 -- .../browser-tracker.updatepageactivity.md | 24 -- .../docs/markdown/browser-tracker.version.md | 11 - .../browser-tracker/docs/markdown/index.md | 12 - trackers/node-tracker/docs/markdown/index.md | 12 - .../node-tracker.adclickevent.advertiserid.md | 13 - .../node-tracker.adclickevent.bannerid.md | 13 - .../node-tracker.adclickevent.campaignid.md | 13 - .../node-tracker.adclickevent.clickid.md | 13 - .../node-tracker.adclickevent.cost.md | 13 - .../node-tracker.adclickevent.costmodel.md | 13 - .../node-tracker.adclickevent.impressionid.md | 13 - .../markdown/node-tracker.adclickevent.md | 32 -- .../node-tracker.adclickevent.targeturl.md | 13 - .../node-tracker.adclickevent.zoneid.md | 13 - .../node-tracker.adconversionevent.action.md | 13 - ...-tracker.adconversionevent.advertiserid.md | 13 - ...de-tracker.adconversionevent.campaignid.md | 13 - ...node-tracker.adconversionevent.category.md | 13 - ...-tracker.adconversionevent.conversionid.md | 13 - .../node-tracker.adconversionevent.cost.md | 13 - ...ode-tracker.adconversionevent.costmodel.md | 13 - ...-tracker.adconversionevent.initialvalue.md | 13 - .../node-tracker.adconversionevent.md | 32 -- ...node-tracker.adconversionevent.property.md | 13 - .../node-tracker.addtocartevent.category.md | 13 - .../node-tracker.addtocartevent.currency.md | 13 - .../markdown/node-tracker.addtocartevent.md | 25 -- .../node-tracker.addtocartevent.name.md | 13 - .../node-tracker.addtocartevent.quantity.md | 13 - .../node-tracker.addtocartevent.sku.md | 13 - .../node-tracker.addtocartevent.unitprice.md | 13 - ...-tracker.adimpressionevent.advertiserid.md | 13 - ...node-tracker.adimpressionevent.bannerid.md | 13 - ...de-tracker.adimpressionevent.campaignid.md | 13 - .../node-tracker.adimpressionevent.cost.md | 13 - ...ode-tracker.adimpressionevent.costmodel.md | 13 - ...-tracker.adimpressionevent.impressionid.md | 13 - .../node-tracker.adimpressionevent.md | 31 -- ...ode-tracker.adimpressionevent.targeturl.md | 13 - .../node-tracker.adimpressionevent.zoneid.md | 13 - .../markdown/node-tracker.buildadclick.md | 30 -- .../node-tracker.buildadconversion.md | 30 -- .../markdown/node-tracker.buildaddtocart.md | 26 -- .../node-tracker.buildadimpression.md | 30 -- .../node-tracker.buildconsentgranted.md | 32 -- .../node-tracker.buildconsentwithdrawn.md | 32 -- .../node-tracker.buildecommercetransaction.md | 26 -- ...e-tracker.buildecommercetransactionitem.md | 26 -- .../node-tracker.buildformfocusorchange.md | 26 -- .../node-tracker.buildformsubmission.md | 26 -- .../markdown/node-tracker.buildlinkclick.md | 26 -- .../markdown/node-tracker.buildpageping.md | 26 -- .../markdown/node-tracker.buildpageview.md | 26 -- .../node-tracker.buildremovefromcart.md | 26 -- .../markdown/node-tracker.buildscreenview.md | 26 -- .../node-tracker.buildselfdescribingevent.md | 26 -- .../markdown/node-tracker.buildsitesearch.md | 26 -- .../node-tracker.buildsocialinteraction.md | 26 -- .../markdown/node-tracker.buildstructevent.md | 26 -- ...tracker.consentgrantedevent.description.md | 13 - ...node-tracker.consentgrantedevent.expiry.md | 13 - .../node-tracker.consentgrantedevent.id.md | 13 - .../node-tracker.consentgrantedevent.md | 24 -- .../node-tracker.consentgrantedevent.name.md | 13 - ...ode-tracker.consentgrantedevent.version.md | 13 - .../node-tracker.consentwithdrawnevent.all.md | 13 - ...acker.consentwithdrawnevent.description.md | 13 - .../node-tracker.consentwithdrawnevent.id.md | 13 - .../node-tracker.consentwithdrawnevent.md | 24 -- ...node-tracker.consentwithdrawnevent.name.md | 13 - ...e-tracker.consentwithdrawnevent.version.md | 13 - .../node-tracker.contextevent.event.md | 13 - .../node-tracker.contextevent.eventschema.md | 18 - .../node-tracker.contextevent.eventtype.md | 18 - .../markdown/node-tracker.contextevent.md | 22 - .../markdown/node-tracker.contextfilter.md | 13 - .../markdown/node-tracker.contextgenerator.md | 13 - .../node-tracker.coreconfiguration.base64.md | 11 - ...node-tracker.coreconfiguration.callback.md | 11 - ...e-tracker.coreconfiguration.coreplugins.md | 11 - .../node-tracker.coreconfiguration.md | 22 - ...e-tracker.coreplugin.activatecoreplugin.md | 18 - .../node-tracker.coreplugin.aftertrack.md | 13 - .../node-tracker.coreplugin.beforetrack.md | 13 - .../node-tracker.coreplugin.contexts.md | 13 - .../node-tracker.coreplugin.logger.md | 13 - .../docs/markdown/node-tracker.coreplugin.md | 24 -- ...r.ecommercetransactionevent.affiliation.md | 13 - ...-tracker.ecommercetransactionevent.city.md | 13 - ...acker.ecommercetransactionevent.country.md | 13 - ...cker.ecommercetransactionevent.currency.md | 13 - .../node-tracker.ecommercetransactionevent.md | 28 -- ...acker.ecommercetransactionevent.orderid.md | 13 - ...cker.ecommercetransactionevent.shipping.md | 13 - ...tracker.ecommercetransactionevent.state.md | 13 - ...e-tracker.ecommercetransactionevent.tax.md | 13 - ...tracker.ecommercetransactionevent.total.md | 13 - ....ecommercetransactionitemevent.category.md | 13 - ....ecommercetransactionitemevent.currency.md | 13 - ...e-tracker.ecommercetransactionitemevent.md | 26 -- ...cker.ecommercetransactionitemevent.name.md | 13 - ...r.ecommercetransactionitemevent.orderid.md | 13 - ...ker.ecommercetransactionitemevent.price.md | 13 - ....ecommercetransactionitemevent.quantity.md | 13 - ...acker.ecommercetransactionitemevent.sku.md | 13 - .../markdown/node-tracker.emitter.flush.md | 11 - .../markdown/node-tracker.emitter.input.md | 11 - .../docs/markdown/node-tracker.emitter.md | 19 - ...r.formfocusorchangeevent.elementclasses.md | 13 - ...racker.formfocusorchangeevent.elementid.md | 13 - ...e-tracker.formfocusorchangeevent.formid.md | 13 - .../node-tracker.formfocusorchangeevent.md | 26 -- ...tracker.formfocusorchangeevent.nodename.md | 13 - ...e-tracker.formfocusorchangeevent.schema.md | 13 - ...ode-tracker.formfocusorchangeevent.type.md | 13 - ...de-tracker.formfocusorchangeevent.value.md | 13 - ...de-tracker.formsubmissionevent.elements.md | 13 - ...tracker.formsubmissionevent.formclasses.md | 13 - ...node-tracker.formsubmissionevent.formid.md | 13 - .../node-tracker.formsubmissionevent.md | 22 - .../docs/markdown/node-tracker.gotemitter.md | 32 -- .../docs/markdown/node-tracker.httpmethod.md | 19 - .../markdown/node-tracker.httpprotocol.md | 19 - ...e-tracker.linkclickevent.elementclasses.md | 13 - ...e-tracker.linkclickevent.elementcontent.md | 13 - .../node-tracker.linkclickevent.elementid.md | 13 - ...de-tracker.linkclickevent.elementtarget.md | 13 - .../markdown/node-tracker.linkclickevent.md | 24 -- .../node-tracker.linkclickevent.targeturl.md | 13 - .../docs/markdown/node-tracker.md | 85 ---- .../node-tracker.pagepingevent.maxxoffset.md | 13 - .../node-tracker.pagepingevent.maxyoffset.md | 13 - .../markdown/node-tracker.pagepingevent.md | 24 -- .../node-tracker.pagepingevent.minxoffset.md | 13 - .../node-tracker.pagepingevent.minyoffset.md | 13 - .../markdown/node-tracker.pageviewevent.md | 22 - .../node-tracker.pageviewevent.pagetitle.md | 13 - .../node-tracker.pageviewevent.pageurl.md | 13 - .../node-tracker.pageviewevent.referrer.md | 13 - .../docs/markdown/node-tracker.payload.md | 13 - .../node-tracker.payloadbuilder.add.md | 13 - ...tracker.payloadbuilder.addcontextentity.md | 13 - .../node-tracker.payloadbuilder.adddict.md | 13 - .../node-tracker.payloadbuilder.addjson.md | 13 - .../node-tracker.payloadbuilder.build.md | 13 - .../node-tracker.payloadbuilder.getjson.md | 13 - .../node-tracker.payloadbuilder.getpayload.md | 13 - .../markdown/node-tracker.payloadbuilder.md | 27 -- ...racker.payloadbuilder.withjsonprocessor.md | 13 - ...de-tracker.removefromcartevent.category.md | 13 - ...de-tracker.removefromcartevent.currency.md | 13 - .../node-tracker.removefromcartevent.md | 25 -- .../node-tracker.removefromcartevent.name.md | 13 - ...de-tracker.removefromcartevent.quantity.md | 13 - .../node-tracker.removefromcartevent.sku.md | 13 - ...e-tracker.removefromcartevent.unitprice.md | 13 - .../node-tracker.screenviewevent.id.md | 13 - .../markdown/node-tracker.screenviewevent.md | 21 - .../node-tracker.screenviewevent.name.md | 13 - .../node-tracker.selfdescribingevent.event.md | 13 - .../node-tracker.selfdescribingevent.md | 20 - .../node-tracker.selfdescribingjson.md | 16 - .../node-tracker.sitesearchevent.filters.md | 13 - .../markdown/node-tracker.sitesearchevent.md | 23 -- ...ode-tracker.sitesearchevent.pageresults.md | 13 - .../node-tracker.sitesearchevent.terms.md | 13 - ...de-tracker.sitesearchevent.totalresults.md | 13 - ...e-tracker.socialinteractionevent.action.md | 13 - .../node-tracker.socialinteractionevent.md | 22 - ...-tracker.socialinteractionevent.network.md | 13 - ...e-tracker.socialinteractionevent.target.md | 13 - .../node-tracker.structuredevent.action.md | 11 - .../node-tracker.structuredevent.category.md | 11 - .../node-tracker.structuredevent.label.md | 11 - .../markdown/node-tracker.structuredevent.md | 24 -- .../node-tracker.structuredevent.property.md | 11 - .../node-tracker.structuredevent.value.md | 11 - .../docs/markdown/node-tracker.timestamp.md | 13 - .../docs/markdown/node-tracker.tracker.md | 22 - .../node-tracker.tracker.setdomainuserid.md | 13 - .../node-tracker.tracker.setnetworkuserid.md | 13 - .../node-tracker.tracker.setsessionid.md | 13 - .../node-tracker.tracker.setsessionindex.md | 13 - .../docs/markdown/node-tracker.version.md | 11 - .../node-tracker/docs/node-tracker.api.md | 375 ----------------- 326 files changed, 6345 deletions(-) delete mode 100644 trackers/browser-tracker/docs/browser-tracker.api.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitycallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitycallbackdata.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.heartbeatdelay.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.minimumvisitlength.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.callback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.addglobalcontexts.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.addplugin.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.anonymoustrackingoptions.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.activatebrowserplugin.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.plugin.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.addplugin.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.clearuserdata.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.core.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableanonymoustracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardbrace.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardhashtag.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytrackingcallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableanonymoustracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.flushbuffer.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getcookiename.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainsessionindex.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserinfo.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getpageviewid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.gettabid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getuserid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.id.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.namespace.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.newsession.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.preservepageviewid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setbuffersize.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcollectorurl.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcookiepath.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcustomurl.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setdocumenttitle.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setreferrerurl.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromcookie.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromlocation.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromreferrer.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setvisitorcookietimeout.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.sharedstate.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.trackpageview.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.updatepageactivity.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clearglobalcontexts.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdata.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preservesession.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preserveuser.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.eventindex.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventtimestamp.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.previoussessionid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionindex.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.storagemechanism.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.userid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.context.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.timestamp.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.conditionalcontextprovider.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.event.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventschema.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventtype.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextfilter.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextgenerator.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.contextprimitive.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.cookiesamesite.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.crossdomainlinker.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.discardbrace.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.discardhashtag.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytrackingcallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustracking.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.options.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.eventmethod.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.filterprovider.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.flushbuffer.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.newbuffersize.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.newsession.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.newtracker.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.newtracker_1.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.contextcallback.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.title.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.platform.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.preservepageviewid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.removeglobalcontexts.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.accept.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.reject.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.rulesetprovider.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.event.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingjson.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setbuffersize.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setcollectorurl.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setcookiepath.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setcustomurl.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setdocumenttitle.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setreferrerurl.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromcookie.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromlocation.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromreferrer.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.setvisitorcookietimeout.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.statestoragestrategy.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.action.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.category.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.label.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.property.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.value.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.trackpageview.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.trackselfdescribingevent.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.trackstructevent.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.updatepageactivity.md delete mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.version.md delete mode 100644 trackers/browser-tracker/docs/markdown/index.md delete mode 100644 trackers/node-tracker/docs/markdown/index.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.advertiserid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.bannerid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.campaignid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.clickid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.cost.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.costmodel.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.impressionid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.targeturl.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adclickevent.zoneid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.action.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.advertiserid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.campaignid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.category.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.conversionid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.cost.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.costmodel.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.initialvalue.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.property.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.category.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.currency.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.name.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.quantity.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.sku.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.unitprice.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.advertiserid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.bannerid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.campaignid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.cost.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.costmodel.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.impressionid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.targeturl.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.zoneid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.description.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.expiry.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.id.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.name.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.version.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.all.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.description.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.id.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.name.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.version.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.contextevent.event.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventschema.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventtype.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.contextevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.contextfilter.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.contextgenerator.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.base64.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.callback.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.coreplugins.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreplugin.aftertrack.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreplugin.beforetrack.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreplugin.contexts.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreplugin.logger.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.affiliation.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.city.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.country.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.currency.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.orderid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.shipping.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.state.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.tax.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.total.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.category.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.currency.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.name.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.orderid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.price.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.quantity.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.sku.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.emitter.flush.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.emitter.input.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.emitter.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementclasses.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.formid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.nodename.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.schema.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.type.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.value.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.elements.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formclasses.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.httpmethod.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.httpprotocol.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementclasses.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementcontent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementtarget.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.targeturl.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxxoffset.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxyoffset.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minxoffset.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minyoffset.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pagetitle.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pageurl.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.referrer.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payload.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.add.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.adddict.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addjson.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.build.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getjson.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getpayload.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.withjsonprocessor.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.category.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.currency.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.name.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.quantity.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.sku.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.unitprice.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.id.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.name.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.event.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.selfdescribingjson.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.filters.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.pageresults.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.terms.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.totalresults.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.action.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.network.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.target.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.structuredevent.action.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.structuredevent.category.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.structuredevent.label.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.structuredevent.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.structuredevent.property.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.structuredevent.value.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.timestamp.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.tracker.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.tracker.setdomainuserid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.tracker.setnetworkuserid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionid.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionindex.md delete mode 100644 trackers/node-tracker/docs/markdown/node-tracker.version.md delete mode 100644 trackers/node-tracker/docs/node-tracker.api.md diff --git a/trackers/browser-tracker/docs/browser-tracker.api.md b/trackers/browser-tracker/docs/browser-tracker.api.md deleted file mode 100644 index 70aabae95..000000000 --- a/trackers/browser-tracker/docs/browser-tracker.api.md +++ /dev/null @@ -1,391 +0,0 @@ -## API Report File for "@snowplow/browser-tracker" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -// @public -export type ActivityCallback = (data: ActivityCallbackData) => void; - -// @public -export type ActivityCallbackData = { - context: Array; - pageViewId: string; - minXOffset: number; - minYOffset: number; - maxXOffset: number; - maxYOffset: number; -}; - -// @public -export interface ActivityTrackingConfiguration { - heartbeatDelay: number; - minimumVisitLength: number; -} - -// @public -export interface ActivityTrackingConfigurationCallback { - callback: ActivityCallback; -} - -// @public -export function addGlobalContexts(contexts: Array, trackers?: Array): void; - -// @public -export function addPlugin(configuration: BrowserPluginConfiguration, trackers?: Array): void; - -// @public (undocumented) -export type AnonymousTrackingOptions = boolean | { - withSessionTracking?: boolean; - withServerAnonymisation?: boolean; -}; - -// Warning: (ae-forgotten-export) The symbol "CorePlugin" needs to be exported by the entry point index.module.d.ts -// -// @public -export interface BrowserPlugin extends CorePlugin { - activateBrowserPlugin?: (tracker: BrowserTracker) => void; -} - -// Warning: (ae-forgotten-export) The symbol "CorePluginConfiguration" needs to be exported by the entry point index.module.d.ts -// -// @public -export interface BrowserPluginConfiguration extends CorePluginConfiguration { - /* The plugin to add */ - // (undocumented) - plugin: BrowserPlugin; -} - -// @public -export interface BrowserTracker { - addPlugin: (configuration: BrowserPluginConfiguration) => void; - clearUserData: (configuration?: ClearUserDataConfiguration) => void; - // Warning: (ae-forgotten-export) The symbol "TrackerCore" needs to be exported by the entry point index.module.d.ts - core: TrackerCore; - crossDomainLinker: (crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean) => void; - disableActivityTracking: () => void; - disableActivityTrackingCallback: () => void; - disableAnonymousTracking: (configuration?: DisableAnonymousTrackingConfiguration) => void; - discardBrace: (enableFilter: boolean) => void; - discardHashTag: (enableFilter: boolean) => void; - enableActivityTracking: (configuration: ActivityTrackingConfiguration) => void; - enableActivityTrackingCallback: (configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback) => void; - enableAnonymousTracking: (configuration?: EnableAnonymousTrackingConfiguration) => void; - flushBuffer: (configuration?: FlushBufferConfiguration) => void; - getCookieName: (basename: string) => void; - getDomainSessionIndex: () => void; - getDomainUserId: () => void; - getDomainUserInfo: () => void; - getPageViewId: () => string; - getTabId: () => string | null; - getUserId: () => void; - id: string; - namespace: string; - newSession: () => void; - preservePageViewId: () => void; - setBufferSize: (newBufferSize: number) => void; - setCollectorUrl: (collectorUrl: string) => void; - setCookiePath: (path: string) => void; - setCustomUrl: (url: string) => void; - setDocumentTitle: (title: string) => void; - setOptOutCookie: (name?: string | null) => void; - setReferrerUrl: (url: string) => void; - setUserId: (userId?: string | null) => void; - setUserIdFromCookie: (cookieName: string) => void; - setUserIdFromLocation: (querystringField: string) => void; - setUserIdFromReferrer: (querystringField: string) => void; - setVisitorCookieTimeout: (timeout: number) => void; - // Warning: (ae-forgotten-export) The symbol "SharedState" needs to be exported by the entry point index.module.d.ts - sharedState: SharedState; - trackPageView: (event?: PageViewEvent & CommonEventProperties) => void; - updatePageActivity: () => void; -} - -// Warning: (ae-forgotten-export) The symbol "RequireAtLeastOne" needs to be exported by the entry point index.module.d.ts -// -// @public (undocumented) -export type BuiltInContexts = RequireAtLeastOne<{ - /* Toggles the web_page context */ - webPage: boolean; - /* Toggles the session context */ - session: boolean; - /* Toggles the browser context */ - browser: boolean; -}> | Record; - -// @public -export function clearGlobalContexts(trackers?: Array): void; - -// @public -export function clearUserData(configuration?: ClearUserDataConfiguration, trackers?: Array): void; - -// @public -export interface ClearUserDataConfiguration { - /* Store session information in memory for subsequent events */ - // (undocumented) - preserveSession: boolean; - /* Store user information in memory for subsequent events */ - // (undocumented) - preserveUser: boolean; -} - -// @public -export interface ClientSession extends Record { - eventIndex: number; - firstEventId: string | null; - firstEventTimestamp: string | null; - previousSessionId: string | null; - sessionId: string; - sessionIndex: number; - storageMechanism: string; - userId: string; -} - -// @public -export interface CommonEventProperties { - context?: Array | null; - // Warning: (ae-forgotten-export) The symbol "Timestamp" needs to be exported by the entry point index.module.d.ts - timestamp?: Timestamp | null; -} - -// @public -export type ConditionalContextProvider = FilterProvider | RuleSetProvider; - -// @public -export interface ContextEvent { - // Warning: (ae-forgotten-export) The symbol "Payload" needs to be exported by the entry point index.module.d.ts - event: Payload; - eventSchema: string; - eventType: string; -} - -// @public -export type ContextFilter = (args?: ContextEvent) => boolean; - -// @public -export type ContextGenerator = (args?: ContextEvent) => SelfDescribingJson | SelfDescribingJson[] | undefined; - -// @public -export type ContextPrimitive = SelfDescribingJson | ContextGenerator; - -// @public (undocumented) -export type CookieSameSite = "None" | "Lax" | "Strict"; - -// @public -export function crossDomainLinker(crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean, trackers?: Array): void; - -// @public -export function disableActivityTracking(trackers?: Array): void; - -// @public -export function disableActivityTrackingCallback(trackers?: Array): void; - -// @public -export function disableAnonymousTracking(configuration?: DisableAnonymousTrackingConfiguration, trackers?: Array): void; - -// @public -export interface DisableAnonymousTrackingConfiguration { - /* Available configurations for different storage strategies */ - // (undocumented) - stateStorageStrategy?: StateStorageStrategy; -} - -// @public -export function discardBrace(enable: boolean, trackers?: Array): void; - -// @public -export function discardHashTag(enable: boolean, trackers?: Array): void; - -// @public -export function enableActivityTracking(configuration: ActivityTrackingConfiguration, trackers?: Array): void; - -// @public -export function enableActivityTrackingCallback(configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback, trackers?: Array): void; - -// @public -export function enableAnonymousTracking(configuration?: EnableAnonymousTrackingConfiguration, trackers?: Array): void; - -// @public -export interface EnableAnonymousTrackingConfiguration { - /* Configuration for Anonymous Tracking */ - // (undocumented) - options?: AnonymousTrackingOptions; - /* Available configurations for different storage strategies */ - // (undocumented) - stateStorageStrategy?: StateStorageStrategy; -} - -// @public (undocumented) -export type EventMethod = "post" | "get" | "beacon"; - -// @public -export type FilterProvider = [ -ContextFilter, -Array | ContextPrimitive -]; - -// @public -export function flushBuffer(configuration?: FlushBufferConfiguration, trackers?: Array): void; - -// @public -export interface FlushBufferConfiguration { - /* The size of the buffer after this flush */ - // (undocumented) - newBufferSize?: number; -} - -// @public -export function newSession(trackers?: Array): void; - -// @public -export function newTracker(trackerId: string, endpoint: string): BrowserTracker; - -// @public -export function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker; - -// @public -export interface PageViewEvent { - contextCallback?: (() => Array) | null; - title?: string | null; -} - -// @public (undocumented) -export type Platform = "web" | "mob" | "pc" | "srv" | "app" | "tv" | "cnsl" | "iot"; - -// @public -export function preservePageViewId(trackers?: Array): void; - -// @public -export function removeGlobalContexts(contexts: Array, trackers?: Array): void; - -// @public -export interface RuleSet { - // (undocumented) - accept?: Array | string; - // (undocumented) - reject?: Array | string; -} - -// @public -export type RuleSetProvider = [ -RuleSet, -Array | ContextPrimitive -]; - -// @public -export interface SelfDescribingEvent { - event: SelfDescribingJson; -} - -// @public -export type SelfDescribingJson = Record> = { - schema: string; - data: T; -}; - -// @public -export function setBufferSize(newBufferSize: number, trackers?: Array): void; - -// @public -export function setCollectorUrl(collectorUrl: string, trackers?: Array): void; - -// @public -export function setCookiePath(path: string, trackers?: Array): void; - -// @public -export function setCustomUrl(url: string, trackers?: Array): void; - -// @public -export function setDocumentTitle(title: string, trackers?: Array): void; - -// @public -export function setOptOutCookie(name?: string | null, trackers?: Array): void; - -// @public -export function setReferrerUrl(url: string, trackers?: Array): void; - -// @public -export function setUserId(userId?: string | null, trackers?: Array): void; - -// @public -export function setUserIdFromCookie(cookieName: string, trackers?: Array): void; - -// @public -export function setUserIdFromLocation(querystringField: string, trackers?: Array): void; - -// @public -export function setUserIdFromReferrer(querystringField: string, trackers?: Array): void; - -// @public -export function setVisitorCookieTimeout(timeout: number, trackers?: Array): void; - -// @public (undocumented) -export type StateStorageStrategy = "cookieAndLocalStorage" | "cookie" | "localStorage" | "none"; - -// @public -export interface StructuredEvent { - // (undocumented) - action: string; - // (undocumented) - category: string; - // (undocumented) - label?: string; - // (undocumented) - property?: string; - // (undocumented) - value?: number; -} - -// @public -export type TrackerConfiguration = { - encodeBase64?: boolean; - cookieDomain?: string; - cookieName?: string; - cookieSameSite?: CookieSameSite; - cookieSecure?: boolean; - cookieLifetime?: number; - withCredentials?: boolean; - sessionCookieTimeout?: number; - appId?: string; - platform?: Platform; - respectDoNotTrack?: boolean; - eventMethod?: EventMethod; - postPath?: string; - useStm?: boolean; - bufferSize?: number; - crossDomainLinker?: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean; - maxPostBytes?: number; - maxGetBytes?: number; - discoverRootDomain?: boolean; - stateStorageStrategy?: StateStorageStrategy; - maxLocalStorageQueueSize?: number; - resetActivityTrackingOnPageView?: boolean; - connectionTimeout?: number; - anonymousTracking?: AnonymousTrackingOptions; - contexts?: BuiltInContexts; - plugins?: Array; - customHeaders?: Record; - retryStatusCodes?: number[]; - dontRetryStatusCodes?: number[]; - onSessionUpdateCallback?: (updatedSession: ClientSession) => void; - idService?: string; -}; - -// @public -export function trackPageView(event?: PageViewEvent & CommonEventProperties, trackers?: Array): void; - -// @public -export function trackSelfDescribingEvent(event: SelfDescribingEvent & CommonEventProperties, trackers?: Array): void; - -// @public -export function trackStructEvent(event: StructuredEvent & CommonEventProperties, trackers?: Array): void; - -// @public -export function updatePageActivity(trackers?: Array): void; - -// @public (undocumented) -export const version: string; - -// (No @packageDocumentation comment for this package) - -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitycallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitycallback.md deleted file mode 100644 index 08a749ed8..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitycallback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityCallback](./browser-tracker.activitycallback.md) - -## ActivityCallback type - -The callback for enableActivityTrackingCallback - -Signature: - -```typescript -type ActivityCallback = (data: ActivityCallbackData) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitycallbackdata.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitycallbackdata.md deleted file mode 100644 index 99a37d953..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitycallbackdata.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityCallbackData](./browser-tracker.activitycallbackdata.md) - -## ActivityCallbackData type - -The data which is passed to the Activity Tracking callback - -Signature: - -```typescript -type ActivityCallbackData = { - context: Array; - pageViewId: string; - minXOffset: number; - minYOffset: number; - maxXOffset: number; - maxYOffset: number; -}; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.heartbeatdelay.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.heartbeatdelay.md deleted file mode 100644 index ca281d710..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.heartbeatdelay.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityTrackingConfiguration](./browser-tracker.activitytrackingconfiguration.md) > [heartbeatDelay](./browser-tracker.activitytrackingconfiguration.heartbeatdelay.md) - -## ActivityTrackingConfiguration.heartbeatDelay property - -The interval at which the callback will be fired - -Signature: - -```typescript -heartbeatDelay: number; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.md deleted file mode 100644 index fc634fbf0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityTrackingConfiguration](./browser-tracker.activitytrackingconfiguration.md) - -## ActivityTrackingConfiguration interface - -The base configuration for activity tracking - -Signature: - -```typescript -interface ActivityTrackingConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [heartbeatDelay](./browser-tracker.activitytrackingconfiguration.heartbeatdelay.md) | number | The interval at which the callback will be fired | -| [minimumVisitLength](./browser-tracker.activitytrackingconfiguration.minimumvisitlength.md) | number | The minimum time that must have elapsed before first heartbeat | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.minimumvisitlength.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.minimumvisitlength.md deleted file mode 100644 index b2fa6f03a..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfiguration.minimumvisitlength.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityTrackingConfiguration](./browser-tracker.activitytrackingconfiguration.md) > [minimumVisitLength](./browser-tracker.activitytrackingconfiguration.minimumvisitlength.md) - -## ActivityTrackingConfiguration.minimumVisitLength property - -The minimum time that must have elapsed before first heartbeat - -Signature: - -```typescript -minimumVisitLength: number; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.callback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.callback.md deleted file mode 100644 index aa792752d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.callback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityTrackingConfigurationCallback](./browser-tracker.activitytrackingconfigurationcallback.md) > [callback](./browser-tracker.activitytrackingconfigurationcallback.callback.md) - -## ActivityTrackingConfigurationCallback.callback property - -The callback to fire based on heart beat - -Signature: - -```typescript -callback: ActivityCallback; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.md deleted file mode 100644 index 74558dc9e..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.activitytrackingconfigurationcallback.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityTrackingConfigurationCallback](./browser-tracker.activitytrackingconfigurationcallback.md) - -## ActivityTrackingConfigurationCallback interface - -The callback for enableActivityTrackingCallback - -Signature: - -```typescript -interface ActivityTrackingConfigurationCallback -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [callback](./browser-tracker.activitytrackingconfigurationcallback.callback.md) | ActivityCallback | The callback to fire based on heart beat | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.addglobalcontexts.md b/trackers/browser-tracker/docs/markdown/browser-tracker.addglobalcontexts.md deleted file mode 100644 index 5b77e0513..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.addglobalcontexts.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [addGlobalContexts](./browser-tracker.addglobalcontexts.md) - -## addGlobalContexts() function - -All provided contexts will be sent with every event - -Signature: - -```typescript -declare function addGlobalContexts(contexts: Array, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| contexts | Array<ConditionalContextProvider \| ContextPrimitive> | An array of contexts or conditional contexts | -| trackers | Array<string> | The tracker identifiers which the global contexts will be added to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.addplugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.addplugin.md deleted file mode 100644 index 8f808e3e9..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.addplugin.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [addPlugin](./browser-tracker.addplugin.md) - -## addPlugin() function - -Add a plugin into the plugin collection after trackers have already been initialised - -Signature: - -```typescript -declare function addPlugin(configuration: BrowserPluginConfiguration, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | BrowserPluginConfiguration | The plugin to add | -| trackers | Array<string> | The tracker identifiers which the plugin will be added to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.anonymoustrackingoptions.md b/trackers/browser-tracker/docs/markdown/browser-tracker.anonymoustrackingoptions.md deleted file mode 100644 index a59581472..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.anonymoustrackingoptions.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [AnonymousTrackingOptions](./browser-tracker.anonymoustrackingoptions.md) - -## AnonymousTrackingOptions type - -Signature: - -```typescript -type AnonymousTrackingOptions = boolean | { - withSessionTracking?: boolean; - withServerAnonymisation?: boolean; -}; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.activatebrowserplugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.activatebrowserplugin.md deleted file mode 100644 index f90d51a13..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.activatebrowserplugin.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserPlugin](./browser-tracker.browserplugin.md) > [activateBrowserPlugin](./browser-tracker.browserplugin.activatebrowserplugin.md) - -## BrowserPlugin.activateBrowserPlugin property - -Called when the plugin is initialised during the Tracker construction - -Signature: - -```typescript -activateBrowserPlugin?: (tracker: BrowserTracker) => void; -``` - -## Remarks - -Use to capture the specific Tracker instance for each instance of a Browser Plugin - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.md deleted file mode 100644 index 6dcf88576..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browserplugin.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserPlugin](./browser-tracker.browserplugin.md) - -## BrowserPlugin interface - -Interface which defines Core Plugins - -Signature: - -```typescript -interface BrowserPlugin extends CorePlugin -``` -Extends: CorePlugin - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [activateBrowserPlugin?](./browser-tracker.browserplugin.activatebrowserplugin.md) | (tracker: BrowserTracker) => void | (Optional) Called when the plugin is initialised during the Tracker construction | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.md deleted file mode 100644 index 16f7248ca..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserPluginConfiguration](./browser-tracker.browserpluginconfiguration.md) - -## BrowserPluginConfiguration interface - -The configuration of the plugin to add - -Signature: - -```typescript -interface BrowserPluginConfiguration extends CorePluginConfiguration -``` -Extends: CorePluginConfiguration - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [plugin](./browser-tracker.browserpluginconfiguration.plugin.md) | BrowserPlugin | | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.plugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.plugin.md deleted file mode 100644 index 53cf2a197..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browserpluginconfiguration.plugin.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserPluginConfiguration](./browser-tracker.browserpluginconfiguration.md) > [plugin](./browser-tracker.browserpluginconfiguration.plugin.md) - -## BrowserPluginConfiguration.plugin property - -Signature: - -```typescript -plugin: BrowserPlugin; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.addplugin.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.addplugin.md deleted file mode 100644 index 0c7680250..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.addplugin.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [addPlugin](./browser-tracker.browsertracker.addplugin.md) - -## BrowserTracker.addPlugin property - -Add a plugin into the plugin collection after Tracker has already been initialised - -Signature: - -```typescript -addPlugin: (configuration: BrowserPluginConfiguration) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.clearuserdata.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.clearuserdata.md deleted file mode 100644 index 9dbf168ce..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.clearuserdata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) - -## BrowserTracker.clearUserData property - -Clears all cookies and local storage containing user and session identifiers - -Signature: - -```typescript -clearUserData: (configuration?: ClearUserDataConfiguration) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.core.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.core.md deleted file mode 100644 index 13f74346b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.core.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [core](./browser-tracker.browsertracker.core.md) - -## BrowserTracker.core property - -The instance of the core library which this tracker has initialised - -Signature: - -```typescript -core: TrackerCore; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md deleted file mode 100644 index 2789a65a9..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) - -## BrowserTracker.crossDomainLinker property - -Enable querystring decoration for links passing a filter - -Signature: - -```typescript -crossDomainLinker: (crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md deleted file mode 100644 index 6b80aec01..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytracking.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) - -## BrowserTracker.disableActivityTracking property - -Disables page activity tracking. - -Signature: - -```typescript -disableActivityTracking: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md deleted file mode 100644 index 056a79fb0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableactivitytrackingcallback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md) - -## BrowserTracker.disableActivityTrackingCallback property - -Disables page activity tracking callback. - -Signature: - -```typescript -disableActivityTrackingCallback: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableanonymoustracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableanonymoustracking.md deleted file mode 100644 index fa892743f..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.disableanonymoustracking.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [disableAnonymousTracking](./browser-tracker.browsertracker.disableanonymoustracking.md) - -## BrowserTracker.disableAnonymousTracking property - -Disables anonymous tracking if active (ie. tracker initialized with `anonymousTracking`) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. - -Signature: - -```typescript -disableAnonymousTracking: (configuration?: DisableAnonymousTrackingConfiguration) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardbrace.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardbrace.md deleted file mode 100644 index 8e56cf4a2..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardbrace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [discardBrace](./browser-tracker.browsertracker.discardbrace.md) - -## BrowserTracker.discardBrace property - -Strip braces from URL - -Signature: - -```typescript -discardBrace: (enableFilter: boolean) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardhashtag.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardhashtag.md deleted file mode 100644 index ee558bc81..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.discardhashtag.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) - -## BrowserTracker.discardHashTag property - -Strip hash tag (or anchor) from URL - -Signature: - -```typescript -discardHashTag: (enableFilter: boolean) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytracking.md deleted file mode 100644 index 4ab54b6f7..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytracking.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [enableActivityTracking](./browser-tracker.browsertracker.enableactivitytracking.md) - -## BrowserTracker.enableActivityTracking property - -Enables page activity tracking (sends page pings to the Collector regularly). - -Signature: - -```typescript -enableActivityTracking: (configuration: ActivityTrackingConfiguration) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytrackingcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytrackingcallback.md deleted file mode 100644 index ae737e9c3..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableactivitytrackingcallback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [enableActivityTrackingCallback](./browser-tracker.browsertracker.enableactivitytrackingcallback.md) - -## BrowserTracker.enableActivityTrackingCallback property - -Enables page activity tracking (replaces collector ping with callback). - -Signature: - -```typescript -enableActivityTrackingCallback: (configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableanonymoustracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableanonymoustracking.md deleted file mode 100644 index 0a0f8d972..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.enableanonymoustracking.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [enableAnonymousTracking](./browser-tracker.browsertracker.enableanonymoustracking.md) - -## BrowserTracker.enableAnonymousTracking property - -Enables anonymous tracking (ie. tracker initialized without `anonymousTracking`) - -Signature: - -```typescript -enableAnonymousTracking: (configuration?: EnableAnonymousTrackingConfiguration) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.flushbuffer.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.flushbuffer.md deleted file mode 100644 index 480e8ad3a..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.flushbuffer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [flushBuffer](./browser-tracker.browsertracker.flushbuffer.md) - -## BrowserTracker.flushBuffer property - -Send all events in the outQueue Only need to use this when sending events with a bufferSize of at least 2 - -Signature: - -```typescript -flushBuffer: (configuration?: FlushBufferConfiguration) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getcookiename.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getcookiename.md deleted file mode 100644 index b0336fc04..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getcookiename.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getCookieName](./browser-tracker.browsertracker.getcookiename.md) - -## BrowserTracker.getCookieName property - -Get the cookie name as cookieNamePrefix + basename + . + domain. - -Signature: - -```typescript -getCookieName: (basename: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainsessionindex.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainsessionindex.md deleted file mode 100644 index 4afdaae42..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainsessionindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) - -## BrowserTracker.getDomainSessionIndex property - -Get the domain session index also known as current memorized visit count. - -Signature: - -```typescript -getDomainSessionIndex: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserid.md deleted file mode 100644 index bf289ede0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) - -## BrowserTracker.getDomainUserId property - -Get visitor ID (from first party cookie) - -Signature: - -```typescript -getDomainUserId: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserinfo.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserinfo.md deleted file mode 100644 index a18733008..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getdomainuserinfo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) - -## BrowserTracker.getDomainUserInfo property - -Get the visitor information (from first party cookie) - -Signature: - -```typescript -getDomainUserInfo: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getpageviewid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getpageviewid.md deleted file mode 100644 index 025419897..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getpageviewid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) - -## BrowserTracker.getPageViewId property - -Get the current page view ID - -Signature: - -```typescript -getPageViewId: () => string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.gettabid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.gettabid.md deleted file mode 100644 index 07addefcc..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.gettabid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getTabId](./browser-tracker.browsertracker.gettabid.md) - -## BrowserTracker.getTabId property - -Get the current browser tab ID - -Signature: - -```typescript -getTabId: () => string | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getuserid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getuserid.md deleted file mode 100644 index 7a32e09d6..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.getuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getUserId](./browser-tracker.browsertracker.getuserid.md) - -## BrowserTracker.getUserId property - -Get the current user ID (as set previously with setUserId()). - -Signature: - -```typescript -getUserId: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.id.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.id.md deleted file mode 100644 index a4ae7f5c4..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [id](./browser-tracker.browsertracker.id.md) - -## BrowserTracker.id property - -The unique identifier of this tracker - -Signature: - -```typescript -id: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md deleted file mode 100644 index abbf32f60..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) - -## BrowserTracker interface - -The Browser Tracker - -Signature: - -```typescript -interface BrowserTracker -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [addPlugin](./browser-tracker.browsertracker.addplugin.md) | (configuration: BrowserPluginConfiguration) => void | Add a plugin into the plugin collection after Tracker has already been initialised | -| [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) => void | Clears all cookies and local storage containing user and session identifiers | -| [core](./browser-tracker.browsertracker.core.md) | TrackerCore | The instance of the core library which this tracker has initialised | -| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) => boolean) => void | Enable querystring decoration for links passing a filter | -| [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) | () => void | Disables page activity tracking. | -| [disableActivityTrackingCallback](./browser-tracker.browsertracker.disableactivitytrackingcallback.md) | () => void | Disables page activity tracking callback. | -| [disableAnonymousTracking](./browser-tracker.browsertracker.disableanonymoustracking.md) | (configuration?: DisableAnonymousTrackingConfiguration) => void | Disables anonymous tracking if active (ie. tracker initialized with anonymousTracking) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. | -| [discardBrace](./browser-tracker.browsertracker.discardbrace.md) | (enableFilter: boolean) => void | Strip braces from URL | -| [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) => void | Strip hash tag (or anchor) from URL | -| [enableActivityTracking](./browser-tracker.browsertracker.enableactivitytracking.md) | (configuration: ActivityTrackingConfiguration) => void | Enables page activity tracking (sends page pings to the Collector regularly). | -| [enableActivityTrackingCallback](./browser-tracker.browsertracker.enableactivitytrackingcallback.md) | (configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback) => void | Enables page activity tracking (replaces collector ping with callback). | -| [enableAnonymousTracking](./browser-tracker.browsertracker.enableanonymoustracking.md) | (configuration?: EnableAnonymousTrackingConfiguration) => void | Enables anonymous tracking (ie. tracker initialized without anonymousTracking) | -| [flushBuffer](./browser-tracker.browsertracker.flushbuffer.md) | (configuration?: FlushBufferConfiguration) => void | Send all events in the outQueue Only need to use this when sending events with a bufferSize of at least 2 | -| [getCookieName](./browser-tracker.browsertracker.getcookiename.md) | (basename: string) => void | Get the cookie name as cookieNamePrefix + basename + . + domain. | -| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () => void | Get the domain session index also known as current memorized visit count. | -| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () => void | Get visitor ID (from first party cookie) | -| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () => void | Get the visitor information (from first party cookie) | -| [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () => string | Get the current page view ID | -| [getTabId](./browser-tracker.browsertracker.gettabid.md) | () => string \| null | Get the current browser tab ID | -| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () => void | Get the current user ID (as set previously with setUserId()). | -| [id](./browser-tracker.browsertracker.id.md) | string | The unique identifier of this tracker | -| [namespace](./browser-tracker.browsertracker.namespace.md) | string | The tracker namespace | -| [newSession](./browser-tracker.browsertracker.newsession.md) | () => void | Expires current session and starts a new session. | -| [preservePageViewId](./browser-tracker.browsertracker.preservepageviewid.md) | () => void | Stop regenerating pageViewId (available from web_page context) | -| [setBufferSize](./browser-tracker.browsertracker.setbuffersize.md) | (newBufferSize: number) => void | Alter buffer size Can be useful if you want to stop batching requests to ensure events start sending closer to event creation | -| [setCollectorUrl](./browser-tracker.browsertracker.setcollectorurl.md) | (collectorUrl: string) => void | Specify the Snowplow collector URL. Specific http or https to force it or leave it off to match the website protocol. | -| [setCookiePath](./browser-tracker.browsertracker.setcookiepath.md) | (path: string) => void | Set first-party cookie path | -| [setCustomUrl](./browser-tracker.browsertracker.setcustomurl.md) | (url: string) => void | Override url | -| [setDocumentTitle](./browser-tracker.browsertracker.setdocumenttitle.md) | (title: string) => void | Override document.title | -| [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) | (name?: string \| null) => void | Sets the opt out cookie. | -| [setReferrerUrl](./browser-tracker.browsertracker.setreferrerurl.md) | (url: string) => void | Override referrer | -| [setUserId](./browser-tracker.browsertracker.setuserid.md) | (userId?: string \| null) => void | Set the business-defined user ID for this user. | -| [setUserIdFromCookie](./browser-tracker.browsertracker.setuseridfromcookie.md) | (cookieName: string) => void | Set the business-defined user ID for this user to the value of a cookie. | -| [setUserIdFromLocation](./browser-tracker.browsertracker.setuseridfromlocation.md) | (querystringField: string) => void | Set the business-defined user ID for this user using the location querystring. | -| [setUserIdFromReferrer](./browser-tracker.browsertracker.setuseridfromreferrer.md) | (querystringField: string) => void | Set the business-defined user ID for this user using the referrer querystring. | -| [setVisitorCookieTimeout](./browser-tracker.browsertracker.setvisitorcookietimeout.md) | (timeout: number) => void | Set visitor cookie timeout (in seconds) | -| [sharedState](./browser-tracker.browsertracker.sharedstate.md) | SharedState | The instance of shared state this tracker is using | -| [trackPageView](./browser-tracker.browsertracker.trackpageview.md) | (event?: PageViewEvent & CommonEventProperties) => void | Log visit to this page | -| [updatePageActivity](./browser-tracker.browsertracker.updatepageactivity.md) | () => void | Triggers the activityHandler manually to allow external user defined activity. i.e. While watching a video | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.namespace.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.namespace.md deleted file mode 100644 index 54b45ae81..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [namespace](./browser-tracker.browsertracker.namespace.md) - -## BrowserTracker.namespace property - -The tracker namespace - -Signature: - -```typescript -namespace: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.newsession.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.newsession.md deleted file mode 100644 index 21b3cf171..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.newsession.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [newSession](./browser-tracker.browsertracker.newsession.md) - -## BrowserTracker.newSession property - -Expires current session and starts a new session. - -Signature: - -```typescript -newSession: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.preservepageviewid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.preservepageviewid.md deleted file mode 100644 index 9a27e24c2..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.preservepageviewid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [preservePageViewId](./browser-tracker.browsertracker.preservepageviewid.md) - -## BrowserTracker.preservePageViewId property - -Stop regenerating `pageViewId` (available from `web_page` context) - -Signature: - -```typescript -preservePageViewId: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setbuffersize.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setbuffersize.md deleted file mode 100644 index abdf8e516..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setbuffersize.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setBufferSize](./browser-tracker.browsertracker.setbuffersize.md) - -## BrowserTracker.setBufferSize property - -Alter buffer size Can be useful if you want to stop batching requests to ensure events start sending closer to event creation - -Signature: - -```typescript -setBufferSize: (newBufferSize: number) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcollectorurl.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcollectorurl.md deleted file mode 100644 index 9b650e49c..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcollectorurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setCollectorUrl](./browser-tracker.browsertracker.setcollectorurl.md) - -## BrowserTracker.setCollectorUrl property - -Specify the Snowplow collector URL. Specific http or https to force it or leave it off to match the website protocol. - -Signature: - -```typescript -setCollectorUrl: (collectorUrl: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcookiepath.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcookiepath.md deleted file mode 100644 index 6a3c800f7..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcookiepath.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setCookiePath](./browser-tracker.browsertracker.setcookiepath.md) - -## BrowserTracker.setCookiePath property - -Set first-party cookie path - -Signature: - -```typescript -setCookiePath: (path: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcustomurl.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcustomurl.md deleted file mode 100644 index f478f0fa9..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setcustomurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setCustomUrl](./browser-tracker.browsertracker.setcustomurl.md) - -## BrowserTracker.setCustomUrl property - -Override url - -Signature: - -```typescript -setCustomUrl: (url: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setdocumenttitle.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setdocumenttitle.md deleted file mode 100644 index 9b6b5e2f7..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setdocumenttitle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setDocumentTitle](./browser-tracker.browsertracker.setdocumenttitle.md) - -## BrowserTracker.setDocumentTitle property - -Override document.title - -Signature: - -```typescript -setDocumentTitle: (title: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md deleted file mode 100644 index fba5b9aa6..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) - -## BrowserTracker.setOptOutCookie property - -Sets the opt out cookie. - -Signature: - -```typescript -setOptOutCookie: (name?: string | null) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setreferrerurl.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setreferrerurl.md deleted file mode 100644 index 6b2b06958..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setreferrerurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setReferrerUrl](./browser-tracker.browsertracker.setreferrerurl.md) - -## BrowserTracker.setReferrerUrl property - -Override referrer - -Signature: - -```typescript -setReferrerUrl: (url: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md deleted file mode 100644 index 020656273..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setUserId](./browser-tracker.browsertracker.setuserid.md) - -## BrowserTracker.setUserId property - -Set the business-defined user ID for this user. - -Signature: - -```typescript -setUserId: (userId?: string | null) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromcookie.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromcookie.md deleted file mode 100644 index 09d2bab52..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromcookie.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setUserIdFromCookie](./browser-tracker.browsertracker.setuseridfromcookie.md) - -## BrowserTracker.setUserIdFromCookie property - -Set the business-defined user ID for this user to the value of a cookie. - -Signature: - -```typescript -setUserIdFromCookie: (cookieName: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromlocation.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromlocation.md deleted file mode 100644 index 780ba562c..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromlocation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setUserIdFromLocation](./browser-tracker.browsertracker.setuseridfromlocation.md) - -## BrowserTracker.setUserIdFromLocation property - -Set the business-defined user ID for this user using the location querystring. - -Signature: - -```typescript -setUserIdFromLocation: (querystringField: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromreferrer.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromreferrer.md deleted file mode 100644 index ed720b6ba..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuseridfromreferrer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setUserIdFromReferrer](./browser-tracker.browsertracker.setuseridfromreferrer.md) - -## BrowserTracker.setUserIdFromReferrer property - -Set the business-defined user ID for this user using the referrer querystring. - -Signature: - -```typescript -setUserIdFromReferrer: (querystringField: string) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setvisitorcookietimeout.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setvisitorcookietimeout.md deleted file mode 100644 index f0f513cb4..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setvisitorcookietimeout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setVisitorCookieTimeout](./browser-tracker.browsertracker.setvisitorcookietimeout.md) - -## BrowserTracker.setVisitorCookieTimeout property - -Set visitor cookie timeout (in seconds) - -Signature: - -```typescript -setVisitorCookieTimeout: (timeout: number) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.sharedstate.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.sharedstate.md deleted file mode 100644 index b5d9a9cf6..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.sharedstate.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [sharedState](./browser-tracker.browsertracker.sharedstate.md) - -## BrowserTracker.sharedState property - -The instance of shared state this tracker is using - -Signature: - -```typescript -sharedState: SharedState; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.trackpageview.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.trackpageview.md deleted file mode 100644 index eab57ea67..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.trackpageview.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [trackPageView](./browser-tracker.browsertracker.trackpageview.md) - -## BrowserTracker.trackPageView property - -Log visit to this page - -Signature: - -```typescript -trackPageView: (event?: PageViewEvent & CommonEventProperties) => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.updatepageactivity.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.updatepageactivity.md deleted file mode 100644 index daf44f828..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.updatepageactivity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [updatePageActivity](./browser-tracker.browsertracker.updatepageactivity.md) - -## BrowserTracker.updatePageActivity property - -Triggers the activityHandler manually to allow external user defined activity. i.e. While watching a video - -Signature: - -```typescript -updatePageActivity: () => void; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md b/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md deleted file mode 100644 index 2d59a6c8b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BuiltInContexts](./browser-tracker.builtincontexts.md) - -## BuiltInContexts type - -Signature: - -```typescript -type BuiltInContexts = RequireAtLeastOne<{ - /* Toggles the web_page context */ - webPage: boolean; - /* Toggles the session context */ - session: boolean; - /* Toggles the browser context */ - browser: boolean; -}> | Record; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clearglobalcontexts.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clearglobalcontexts.md deleted file mode 100644 index 350d12d8f..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clearglobalcontexts.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [clearGlobalContexts](./browser-tracker.clearglobalcontexts.md) - -## clearGlobalContexts() function - -Clear all global contexts that are sent with events - -Signature: - -```typescript -declare function clearGlobalContexts(trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackers | Array<string> | The tracker identifiers which the global contexts will be cleared from | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdata.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdata.md deleted file mode 100644 index 940d63735..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdata.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [clearUserData](./browser-tracker.clearuserdata.md) - -## clearUserData() function - -Clears all cookies and local storage containing user and session identifiers - -Signature: - -```typescript -declare function clearUserData(configuration?: ClearUserDataConfiguration, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | ClearUserDataConfiguration | | -| trackers | Array<string> | The tracker identifiers which the event will be sent to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.md deleted file mode 100644 index 8a8663c61..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) - -## ClearUserDataConfiguration interface - -The configuration that can be changed when enabling anonymous tracking - -Signature: - -```typescript -interface ClearUserDataConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [preserveSession](./browser-tracker.clearuserdataconfiguration.preservesession.md) | boolean | | -| [preserveUser](./browser-tracker.clearuserdataconfiguration.preserveuser.md) | boolean | | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preservesession.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preservesession.md deleted file mode 100644 index ab798699d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preservesession.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) > [preserveSession](./browser-tracker.clearuserdataconfiguration.preservesession.md) - -## ClearUserDataConfiguration.preserveSession property - -Signature: - -```typescript -preserveSession: boolean; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preserveuser.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preserveuser.md deleted file mode 100644 index 0920602b2..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clearuserdataconfiguration.preserveuser.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) > [preserveUser](./browser-tracker.clearuserdataconfiguration.preserveuser.md) - -## ClearUserDataConfiguration.preserveUser property - -Signature: - -```typescript -preserveUser: boolean; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.eventindex.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.eventindex.md deleted file mode 100644 index e2e336de3..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.eventindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [eventIndex](./browser-tracker.clientsession.eventindex.md) - -## ClientSession.eventIndex property - -Index of the current event in the session - -Signature: - -```typescript -eventIndex: number; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventid.md deleted file mode 100644 index 8c34c93c2..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [firstEventId](./browser-tracker.clientsession.firsteventid.md) - -## ClientSession.firstEventId property - -Identifier of the first event for this session - -Signature: - -```typescript -firstEventId: string | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventtimestamp.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventtimestamp.md deleted file mode 100644 index 78c6ad599..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.firsteventtimestamp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [firstEventTimestamp](./browser-tracker.clientsession.firsteventtimestamp.md) - -## ClientSession.firstEventTimestamp property - -Date-time timestamp of when the first event in the session was tracked - -Signature: - -```typescript -firstEventTimestamp: string | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.md deleted file mode 100644 index bbec2182b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) - -## ClientSession interface - -Schema for client client session context entity - -Signature: - -```typescript -interface ClientSession extends Record -``` -Extends: Record<string, unknown> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [eventIndex](./browser-tracker.clientsession.eventindex.md) | number | Index of the current event in the session | -| [firstEventId](./browser-tracker.clientsession.firsteventid.md) | string \| null | Identifier of the first event for this session | -| [firstEventTimestamp](./browser-tracker.clientsession.firsteventtimestamp.md) | string \| null | Date-time timestamp of when the first event in the session was tracked | -| [previousSessionId](./browser-tracker.clientsession.previoussessionid.md) | string \| null | The previous session identifier for this user | -| [sessionId](./browser-tracker.clientsession.sessionid.md) | string | An identifier for the session (same as domain\_sessionid) | -| [sessionIndex](./browser-tracker.clientsession.sessionindex.md) | number | The index of the current session for this user (same as domain\_sessionidx) | -| [storageMechanism](./browser-tracker.clientsession.storagemechanism.md) | string | The mechanism that the session information has been stored on the device | -| [userId](./browser-tracker.clientsession.userid.md) | string | An identifier for the user of the session (same as domain\_userid) | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.previoussessionid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.previoussessionid.md deleted file mode 100644 index 594b71530..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.previoussessionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [previousSessionId](./browser-tracker.clientsession.previoussessionid.md) - -## ClientSession.previousSessionId property - -The previous session identifier for this user - -Signature: - -```typescript -previousSessionId: string | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionid.md deleted file mode 100644 index 51707d88d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [sessionId](./browser-tracker.clientsession.sessionid.md) - -## ClientSession.sessionId property - -An identifier for the session (same as domain\_sessionid) - -Signature: - -```typescript -sessionId: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionindex.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionindex.md deleted file mode 100644 index cc40d5458..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.sessionindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [sessionIndex](./browser-tracker.clientsession.sessionindex.md) - -## ClientSession.sessionIndex property - -The index of the current session for this user (same as domain\_sessionidx) - -Signature: - -```typescript -sessionIndex: number; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.storagemechanism.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.storagemechanism.md deleted file mode 100644 index 5dfd14eaa..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.storagemechanism.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [storageMechanism](./browser-tracker.clientsession.storagemechanism.md) - -## ClientSession.storageMechanism property - -The mechanism that the session information has been stored on the device - -Signature: - -```typescript -storageMechanism: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.userid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.userid.md deleted file mode 100644 index 3df2405e0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.clientsession.userid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [userId](./browser-tracker.clientsession.userid.md) - -## ClientSession.userId property - -An identifier for the user of the session (same as domain\_userid) - -Signature: - -```typescript -userId: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.context.md b/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.context.md deleted file mode 100644 index c038c9cc4..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.context.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CommonEventProperties](./browser-tracker.commoneventproperties.md) > [context](./browser-tracker.commoneventproperties.context.md) - -## CommonEventProperties.context property - -Add context to an event by setting an Array of Self Describing JSON - -Signature: - -```typescript -context?: Array | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.md b/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.md deleted file mode 100644 index 4cf044323..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CommonEventProperties](./browser-tracker.commoneventproperties.md) - -## CommonEventProperties interface - -Additional data points to set when tracking an event - -Signature: - -```typescript -interface CommonEventProperties -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context?](./browser-tracker.commoneventproperties.context.md) | Array<SelfDescribingJson> \| null | (Optional) Add context to an event by setting an Array of Self Describing JSON | -| [timestamp?](./browser-tracker.commoneventproperties.timestamp.md) | Timestamp \| null | (Optional) Set the true timestamp or overwrite the device sent timestamp on an event | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.timestamp.md b/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.timestamp.md deleted file mode 100644 index 083fec1a5..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.commoneventproperties.timestamp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CommonEventProperties](./browser-tracker.commoneventproperties.md) > [timestamp](./browser-tracker.commoneventproperties.timestamp.md) - -## CommonEventProperties.timestamp property - -Set the true timestamp or overwrite the device sent timestamp on an event - -Signature: - -```typescript -timestamp?: Timestamp | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.conditionalcontextprovider.md b/trackers/browser-tracker/docs/markdown/browser-tracker.conditionalcontextprovider.md deleted file mode 100644 index daa9c8f2f..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.conditionalcontextprovider.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ConditionalContextProvider](./browser-tracker.conditionalcontextprovider.md) - -## ConditionalContextProvider type - -Conditional context providers are two element arrays used to decide when to attach contexts, where: - the first element is some conditional criterion - the second element is any number of context primitives - -Signature: - -```typescript -type ConditionalContextProvider = FilterProvider | RuleSetProvider; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.event.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.event.md deleted file mode 100644 index 15e2fb795..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextEvent](./browser-tracker.contextevent.md) > [event](./browser-tracker.contextevent.event.md) - -## ContextEvent.event property - -The event payload - -Signature: - -```typescript -event: Payload; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventschema.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventschema.md deleted file mode 100644 index 5538afb51..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventschema.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextEvent](./browser-tracker.contextevent.md) > [eventSchema](./browser-tracker.contextevent.eventschema.md) - -## ContextEvent.eventSchema property - -The event schema where one is available, or empty string - -Signature: - -```typescript -eventSchema: string; -``` - -## Example - -'iglu:com.snowplowanalytics.snowplow/ad\_impression/jsonschema/1-0-0' - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventtype.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventtype.md deleted file mode 100644 index bffc498d3..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.eventtype.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextEvent](./browser-tracker.contextevent.md) > [eventType](./browser-tracker.contextevent.eventtype.md) - -## ContextEvent.eventType property - -The event type - -Signature: - -```typescript -eventType: string; -``` - -## Example - -'page\_view' - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.md deleted file mode 100644 index 48f7d228d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextEvent](./browser-tracker.contextevent.md) - -## ContextEvent interface - -Argument for [ContextGenerator](./browser-tracker.contextgenerator.md) and [ContextFilter](./browser-tracker.contextfilter.md) callback - -Signature: - -```typescript -interface ContextEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event](./browser-tracker.contextevent.event.md) | Payload | The event payload | -| [eventSchema](./browser-tracker.contextevent.eventschema.md) | string | The event schema where one is available, or empty string | -| [eventType](./browser-tracker.contextevent.eventtype.md) | string | The event type | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextfilter.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextfilter.md deleted file mode 100644 index 372d95274..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextfilter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextFilter](./browser-tracker.contextfilter.md) - -## ContextFilter type - -A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event - -Signature: - -```typescript -type ContextFilter = (args?: ContextEvent) => boolean; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextgenerator.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextgenerator.md deleted file mode 100644 index 2fb65af74..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextgenerator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextGenerator](./browser-tracker.contextgenerator.md) - -## ContextGenerator type - -A context generator is a user-supplied callback that is evaluated for each event to allow an additional context to be dynamically attached to the event - -Signature: - -```typescript -type ContextGenerator = (args?: ContextEvent) => SelfDescribingJson | SelfDescribingJson[] | undefined; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.contextprimitive.md b/trackers/browser-tracker/docs/markdown/browser-tracker.contextprimitive.md deleted file mode 100644 index 6d3f109dd..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.contextprimitive.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextPrimitive](./browser-tracker.contextprimitive.md) - -## ContextPrimitive type - -A context primitive is either a self-describing JSON or a context generator - -Signature: - -```typescript -type ContextPrimitive = SelfDescribingJson | ContextGenerator; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.cookiesamesite.md b/trackers/browser-tracker/docs/markdown/browser-tracker.cookiesamesite.md deleted file mode 100644 index 946fb40e6..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.cookiesamesite.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CookieSameSite](./browser-tracker.cookiesamesite.md) - -## CookieSameSite type - -Signature: - -```typescript -type CookieSameSite = "None" | "Lax" | "Strict"; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.crossdomainlinker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.crossdomainlinker.md deleted file mode 100644 index 63cfcbd3b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.crossdomainlinker.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [crossDomainLinker](./browser-tracker.crossdomainlinker.md) - -## crossDomainLinker() function - -Enable querystring decoration for links pasing a filter - -Signature: - -```typescript -declare function crossDomainLinker(crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| crossDomainLinkerCriterion | (elt: HTMLAnchorElement \| HTMLAreaElement) => boolean | | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md deleted file mode 100644 index be17fdb57..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytracking.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [disableActivityTracking](./browser-tracker.disableactivitytracking.md) - -## disableActivityTracking() function - -Disables page activity tracking. - -Signature: - -```typescript -declare function disableActivityTracking(trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackers | Array<string> | The tracker identifiers the activity tracking will be disabled. | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md deleted file mode 100644 index 9b15963b1..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.disableactivitytrackingcallback.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [disableActivityTrackingCallback](./browser-tracker.disableactivitytrackingcallback.md) - -## disableActivityTrackingCallback() function - -Disables page activity tracking callback. - -Signature: - -```typescript -declare function disableActivityTrackingCallback(trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackers | Array<string> | The tracker identifiers the activity tracking callback will be disabled. | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustracking.md deleted file mode 100644 index 6a06c91f2..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustracking.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [disableAnonymousTracking](./browser-tracker.disableanonymoustracking.md) - -## disableAnonymousTracking() function - -Disables anonymous tracking if active (ie. tracker initialized with `anonymousTracking`) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. - -Signature: - -```typescript -declare function disableAnonymousTracking(configuration?: DisableAnonymousTrackingConfiguration, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | DisableAnonymousTrackingConfiguration | The configuration for disabling anonymous tracking | -| trackers | Array<string> | The tracker identifiers which the event will be sent to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.md deleted file mode 100644 index 8845e67b3..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DisableAnonymousTrackingConfiguration](./browser-tracker.disableanonymoustrackingconfiguration.md) - -## DisableAnonymousTrackingConfiguration interface - -The configuration that can be changed when disabling anonymous tracking - -Signature: - -```typescript -interface DisableAnonymousTrackingConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [stateStorageStrategy?](./browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md) | StateStorageStrategy | (Optional) | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md b/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md deleted file mode 100644 index e7b3c4665..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DisableAnonymousTrackingConfiguration](./browser-tracker.disableanonymoustrackingconfiguration.md) > [stateStorageStrategy](./browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md) - -## DisableAnonymousTrackingConfiguration.stateStorageStrategy property - -Signature: - -```typescript -stateStorageStrategy?: StateStorageStrategy; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.discardbrace.md b/trackers/browser-tracker/docs/markdown/browser-tracker.discardbrace.md deleted file mode 100644 index 2e6ce2087..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.discardbrace.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [discardBrace](./browser-tracker.discardbrace.md) - -## discardBrace() function - -Strip braces from URL - -Signature: - -```typescript -declare function discardBrace(enable: boolean, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| enable | boolean | Whther to enable stripping of braces | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.discardhashtag.md b/trackers/browser-tracker/docs/markdown/browser-tracker.discardhashtag.md deleted file mode 100644 index a856d108b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.discardhashtag.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [discardHashTag](./browser-tracker.discardhashtag.md) - -## discardHashTag() function - -Strip hash tag (or anchor) from URL - -Signature: - -```typescript -declare function discardHashTag(enable: boolean, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| enable | boolean | Whether to enable stripping of hash | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytracking.md deleted file mode 100644 index 106a503e1..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytracking.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [enableActivityTracking](./browser-tracker.enableactivitytracking.md) - -## enableActivityTracking() function - -Enables page activity tracking (sends page pings to the Collector regularly). - -Signature: - -```typescript -declare function enableActivityTracking(configuration: ActivityTrackingConfiguration, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | ActivityTrackingConfiguration | The activity tracking configuration | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytrackingcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytrackingcallback.md deleted file mode 100644 index 22a099ac3..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.enableactivitytrackingcallback.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [enableActivityTrackingCallback](./browser-tracker.enableactivitytrackingcallback.md) - -## enableActivityTrackingCallback() function - -Enables page activity tracking (replaces collector ping with callback). - -Signature: - -```typescript -declare function enableActivityTrackingCallback(configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback | The activity tracking callback configuration | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustracking.md b/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustracking.md deleted file mode 100644 index 07cf432e2..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustracking.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [enableAnonymousTracking](./browser-tracker.enableanonymoustracking.md) - -## enableAnonymousTracking() function - -Enables anonymous tracking (ie. tracker initialized without `anonymousTracking`) - -Signature: - -```typescript -declare function enableAnonymousTracking(configuration?: EnableAnonymousTrackingConfiguration, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | EnableAnonymousTrackingConfiguration | The configuration for enabling anonymous tracking | -| trackers | Array<string> | The tracker identifiers which the event will be sent to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.md deleted file mode 100644 index e9205986b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) - -## EnableAnonymousTrackingConfiguration interface - -The configuration that can be changed when enabling anonymous tracking - -Signature: - -```typescript -interface EnableAnonymousTrackingConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [options?](./browser-tracker.enableanonymoustrackingconfiguration.options.md) | AnonymousTrackingOptions | (Optional) | -| [stateStorageStrategy?](./browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md) | StateStorageStrategy | (Optional) | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.options.md b/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.options.md deleted file mode 100644 index 2a4a3da12..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.options.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) > [options](./browser-tracker.enableanonymoustrackingconfiguration.options.md) - -## EnableAnonymousTrackingConfiguration.options property - -Signature: - -```typescript -options?: AnonymousTrackingOptions; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md b/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md deleted file mode 100644 index 346abcf49..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) > [stateStorageStrategy](./browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md) - -## EnableAnonymousTrackingConfiguration.stateStorageStrategy property - -Signature: - -```typescript -stateStorageStrategy?: StateStorageStrategy; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.eventmethod.md b/trackers/browser-tracker/docs/markdown/browser-tracker.eventmethod.md deleted file mode 100644 index 94dfa18d1..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.eventmethod.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventMethod](./browser-tracker.eventmethod.md) - -## EventMethod type - -Signature: - -```typescript -type EventMethod = "post" | "get" | "beacon"; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.filterprovider.md b/trackers/browser-tracker/docs/markdown/browser-tracker.filterprovider.md deleted file mode 100644 index 015f42f22..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.filterprovider.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [FilterProvider](./browser-tracker.filterprovider.md) - -## FilterProvider type - -A filter provider is a tuple that has two parts: a context filter and the context primitive(s) If the context filter evaluates to true, the tracker will attach the context primitive(s) - -Signature: - -```typescript -type FilterProvider = [ - ContextFilter, - Array | ContextPrimitive -]; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.flushbuffer.md b/trackers/browser-tracker/docs/markdown/browser-tracker.flushbuffer.md deleted file mode 100644 index 27ab8f848..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.flushbuffer.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [flushBuffer](./browser-tracker.flushbuffer.md) - -## flushBuffer() function - -Send all events in the outQueue Only need to use this when sending events with a bufferSize of at least 2 - -Signature: - -```typescript -declare function flushBuffer(configuration?: FlushBufferConfiguration, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| configuration | FlushBufferConfiguration | The configuration to use following flushing the buffer | -| trackers | Array<string> | The tracker identifiers which will be flushed | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.md deleted file mode 100644 index d2f73779f..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [FlushBufferConfiguration](./browser-tracker.flushbufferconfiguration.md) - -## FlushBufferConfiguration interface - -The configuration that can be changed when flushing the buffer - -Signature: - -```typescript -interface FlushBufferConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [newBufferSize?](./browser-tracker.flushbufferconfiguration.newbuffersize.md) | number | (Optional) | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.newbuffersize.md b/trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.newbuffersize.md deleted file mode 100644 index 1607d9d32..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.flushbufferconfiguration.newbuffersize.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [FlushBufferConfiguration](./browser-tracker.flushbufferconfiguration.md) > [newBufferSize](./browser-tracker.flushbufferconfiguration.newbuffersize.md) - -## FlushBufferConfiguration.newBufferSize property - -Signature: - -```typescript -newBufferSize?: number; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.md deleted file mode 100644 index 66ea8d974..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.md +++ /dev/null @@ -1,94 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) - -## browser-tracker package - -## Functions - -| Function | Description | -| --- | --- | -| [addGlobalContexts(contexts, trackers)](./browser-tracker.addglobalcontexts.md) | All provided contexts will be sent with every event | -| [addPlugin(configuration, trackers)](./browser-tracker.addplugin.md) | Add a plugin into the plugin collection after trackers have already been initialised | -| [clearGlobalContexts(trackers)](./browser-tracker.clearglobalcontexts.md) | Clear all global contexts that are sent with events | -| [clearUserData(configuration, trackers)](./browser-tracker.clearuserdata.md) | Clears all cookies and local storage containing user and session identifiers | -| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links pasing a filter | -| [disableActivityTracking(trackers)](./browser-tracker.disableactivitytracking.md) | Disables page activity tracking. | -| [disableActivityTrackingCallback(trackers)](./browser-tracker.disableactivitytrackingcallback.md) | Disables page activity tracking callback. | -| [disableAnonymousTracking(configuration, trackers)](./browser-tracker.disableanonymoustracking.md) | Disables anonymous tracking if active (ie. tracker initialized with anonymousTracking) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. | -| [discardBrace(enable, trackers)](./browser-tracker.discardbrace.md) | Strip braces from URL | -| [discardHashTag(enable, trackers)](./browser-tracker.discardhashtag.md) | Strip hash tag (or anchor) from URL | -| [enableActivityTracking(configuration, trackers)](./browser-tracker.enableactivitytracking.md) | Enables page activity tracking (sends page pings to the Collector regularly). | -| [enableActivityTrackingCallback(configuration, trackers)](./browser-tracker.enableactivitytrackingcallback.md) | Enables page activity tracking (replaces collector ping with callback). | -| [enableAnonymousTracking(configuration, trackers)](./browser-tracker.enableanonymoustracking.md) | Enables anonymous tracking (ie. tracker initialized without anonymousTracking) | -| [flushBuffer(configuration, trackers)](./browser-tracker.flushbuffer.md) | Send all events in the outQueue Only need to use this when sending events with a bufferSize of at least 2 | -| [newSession(trackers)](./browser-tracker.newsession.md) | Expires current session and starts a new session. | -| [newTracker(trackerId, endpoint)](./browser-tracker.newtracker.md) | Initialise a new tracker | -| [newTracker(trackerId, endpoint, configuration)](./browser-tracker.newtracker_1.md) | Initialise a new tracker | -| [preservePageViewId(trackers)](./browser-tracker.preservepageviewid.md) | Stop regenerating pageViewId (available from web_page context) | -| [removeGlobalContexts(contexts, trackers)](./browser-tracker.removeglobalcontexts.md) | All provided contexts will no longer be sent with every event | -| [setBufferSize(newBufferSize, trackers)](./browser-tracker.setbuffersize.md) | Set the buffer size Can be useful if you want to stop batching requests to ensure events start sending closer to event creation | -| [setCollectorUrl(collectorUrl, trackers)](./browser-tracker.setcollectorurl.md) | Specify the Snowplow collector URL. Specific http or https to force it or leave it off to match the website protocol. | -| [setCookiePath(path, trackers)](./browser-tracker.setcookiepath.md) | Set first-party cookie path | -| [setCustomUrl(url, trackers)](./browser-tracker.setcustomurl.md) | Override url | -| [setDocumentTitle(title, trackers)](./browser-tracker.setdocumenttitle.md) | Override document.title | -| [setOptOutCookie(name, trackers)](./browser-tracker.setoptoutcookie.md) | Sets the opt out cookie. | -| [setReferrerUrl(url, trackers)](./browser-tracker.setreferrerurl.md) | Override referrer | -| [setUserId(userId, trackers)](./browser-tracker.setuserid.md) | Set the business-defined user ID for this user. | -| [setUserIdFromCookie(cookieName, trackers)](./browser-tracker.setuseridfromcookie.md) | Set the business-defined user ID for this user to the value of a cookie. | -| [setUserIdFromLocation(querystringField, trackers)](./browser-tracker.setuseridfromlocation.md) | Set the business-defined user ID for this user using the location querystring. | -| [setUserIdFromReferrer(querystringField, trackers)](./browser-tracker.setuseridfromreferrer.md) | Set the business-defined user ID for this user using the referrer querystring. | -| [setVisitorCookieTimeout(timeout, trackers)](./browser-tracker.setvisitorcookietimeout.md) | Set visitor cookie timeout (in seconds) | -| [trackPageView(event, trackers)](./browser-tracker.trackpageview.md) | Track a visit to a web page | -| [trackSelfDescribingEvent(event, trackers)](./browser-tracker.trackselfdescribingevent.md) | Track a self-describing event happening on this page. A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema | -| [trackStructEvent(event, trackers)](./browser-tracker.trackstructevent.md) | Track a structured event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. | -| [updatePageActivity(trackers)](./browser-tracker.updatepageactivity.md) | Triggers the activityHandler manually to allow external user defined activity. i.e. While watching a video | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [ActivityTrackingConfiguration](./browser-tracker.activitytrackingconfiguration.md) | The base configuration for activity tracking | -| [ActivityTrackingConfigurationCallback](./browser-tracker.activitytrackingconfigurationcallback.md) | The callback for enableActivityTrackingCallback | -| [BrowserPlugin](./browser-tracker.browserplugin.md) | Interface which defines Core Plugins | -| [BrowserPluginConfiguration](./browser-tracker.browserpluginconfiguration.md) | The configuration of the plugin to add | -| [BrowserTracker](./browser-tracker.browsertracker.md) | The Browser Tracker | -| [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) | The configuration that can be changed when enabling anonymous tracking | -| [ClientSession](./browser-tracker.clientsession.md) | Schema for client client session context entity | -| [CommonEventProperties](./browser-tracker.commoneventproperties.md) | Additional data points to set when tracking an event | -| [ContextEvent](./browser-tracker.contextevent.md) | Argument for [ContextGenerator](./browser-tracker.contextgenerator.md) and [ContextFilter](./browser-tracker.contextfilter.md) callback | -| [DisableAnonymousTrackingConfiguration](./browser-tracker.disableanonymoustrackingconfiguration.md) | The configuration that can be changed when disabling anonymous tracking | -| [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) | The configuration that can be changed when enabling anonymous tracking | -| [FlushBufferConfiguration](./browser-tracker.flushbufferconfiguration.md) | The configuration that can be changed when flushing the buffer | -| [PageViewEvent](./browser-tracker.pageviewevent.md) | A Page View event Used for tracking a page view | -| [RuleSet](./browser-tracker.ruleset.md) | A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs | -| [SelfDescribingEvent](./browser-tracker.selfdescribingevent.md) | A Self Describing Event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema | -| [StructuredEvent](./browser-tracker.structuredevent.md) | A Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. | - -## Variables - -| Variable | Description | -| --- | --- | -| [version](./browser-tracker.version.md) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [ActivityCallback](./browser-tracker.activitycallback.md) | The callback for enableActivityTrackingCallback | -| [ActivityCallbackData](./browser-tracker.activitycallbackdata.md) | The data which is passed to the Activity Tracking callback | -| [AnonymousTrackingOptions](./browser-tracker.anonymoustrackingoptions.md) | | -| [BuiltInContexts](./browser-tracker.builtincontexts.md) | | -| [ConditionalContextProvider](./browser-tracker.conditionalcontextprovider.md) | Conditional context providers are two element arrays used to decide when to attach contexts, where: - the first element is some conditional criterion - the second element is any number of context primitives | -| [ContextFilter](./browser-tracker.contextfilter.md) | A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event | -| [ContextGenerator](./browser-tracker.contextgenerator.md) | A context generator is a user-supplied callback that is evaluated for each event to allow an additional context to be dynamically attached to the event | -| [ContextPrimitive](./browser-tracker.contextprimitive.md) | A context primitive is either a self-describing JSON or a context generator | -| [CookieSameSite](./browser-tracker.cookiesamesite.md) | | -| [EventMethod](./browser-tracker.eventmethod.md) | | -| [FilterProvider](./browser-tracker.filterprovider.md) | A filter provider is a tuple that has two parts: a context filter and the context primitive(s) If the context filter evaluates to true, the tracker will attach the context primitive(s) | -| [Platform](./browser-tracker.platform.md) | | -| [RuleSetProvider](./browser-tracker.rulesetprovider.md) | A ruleset provider is aa tuple that has two parts: a ruleset and the context primitive(s) If the ruleset allows the current event schema URI, the tracker will attach the context primitive(s) | -| [SelfDescribingJson](./browser-tracker.selfdescribingjson.md) | export interface for any Self-Describing JSON such as context or Self Describing events | -| [StateStorageStrategy](./browser-tracker.statestoragestrategy.md) | | -| [TrackerConfiguration](./browser-tracker.trackerconfiguration.md) | The configuration object for initialising the tracker | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.newsession.md b/trackers/browser-tracker/docs/markdown/browser-tracker.newsession.md deleted file mode 100644 index c742a4f1d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.newsession.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [newSession](./browser-tracker.newsession.md) - -## newSession() function - -Expires current session and starts a new session. - -Signature: - -```typescript -declare function newSession(trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackers | Array<string> | The tracker identifiers which will have their session refreshed | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.newtracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.newtracker.md deleted file mode 100644 index 446ff6375..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.newtracker.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [newTracker](./browser-tracker.newtracker.md) - -## newTracker() function - -Initialise a new tracker - -Signature: - -```typescript -declare function newTracker(trackerId: string, endpoint: string): BrowserTracker; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackerId | string | The tracker id - also known as tracker namespace | -| endpoint | string | Collector endpoint in the form collector.mysite.com | - -Returns: - -BrowserTracker - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.newtracker_1.md b/trackers/browser-tracker/docs/markdown/browser-tracker.newtracker_1.md deleted file mode 100644 index ac03fc02a..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.newtracker_1.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [newTracker](./browser-tracker.newtracker_1.md) - -## newTracker() function - -Initialise a new tracker - -Signature: - -```typescript -declare function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackerId | string | The tracker id - also known as tracker namespace | -| endpoint | string | Collector endpoint in the form collector.mysite.com | -| configuration | TrackerConfiguration | The initialisation options of the tracker | - -Returns: - -BrowserTracker - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.contextcallback.md b/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.contextcallback.md deleted file mode 100644 index 2da5fd1c0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.contextcallback.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PageViewEvent](./browser-tracker.pageviewevent.md) > [contextCallback](./browser-tracker.pageviewevent.contextcallback.md) - -## PageViewEvent.contextCallback property - -A callback which will fire on the page view and each subsequent activity tracking event for this page view - -Signature: - -```typescript -contextCallback?: (() => Array) | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.md b/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.md deleted file mode 100644 index e000ce1c6..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PageViewEvent](./browser-tracker.pageviewevent.md) - -## PageViewEvent interface - -A Page View event Used for tracking a page view - -Signature: - -```typescript -interface PageViewEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [contextCallback?](./browser-tracker.pageviewevent.contextcallback.md) | (() => Array<SelfDescribingJson>) \| null | (Optional) A callback which will fire on the page view and each subsequent activity tracking event for this page view | -| [title?](./browser-tracker.pageviewevent.title.md) | string \| null | (Optional) Override the page title | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.title.md b/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.title.md deleted file mode 100644 index 0f42ddf6f..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.pageviewevent.title.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PageViewEvent](./browser-tracker.pageviewevent.md) > [title](./browser-tracker.pageviewevent.title.md) - -## PageViewEvent.title property - -Override the page title - -Signature: - -```typescript -title?: string | null; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.platform.md b/trackers/browser-tracker/docs/markdown/browser-tracker.platform.md deleted file mode 100644 index 505fdfb6b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.platform.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Platform](./browser-tracker.platform.md) - -## Platform type - -Signature: - -```typescript -type Platform = "web" | "mob" | "pc" | "srv" | "app" | "tv" | "cnsl" | "iot"; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.preservepageviewid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.preservepageviewid.md deleted file mode 100644 index decb1ef37..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.preservepageviewid.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [preservePageViewId](./browser-tracker.preservepageviewid.md) - -## preservePageViewId() function - -Stop regenerating `pageViewId` (available from `web_page` context) - -Signature: - -```typescript -declare function preservePageViewId(trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackers | Array<string> | The tracker identifiers which the event will preserve their Page View Ids | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.removeglobalcontexts.md b/trackers/browser-tracker/docs/markdown/browser-tracker.removeglobalcontexts.md deleted file mode 100644 index 35eece5fb..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.removeglobalcontexts.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [removeGlobalContexts](./browser-tracker.removeglobalcontexts.md) - -## removeGlobalContexts() function - -All provided contexts will no longer be sent with every event - -Signature: - -```typescript -declare function removeGlobalContexts(contexts: Array, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| contexts | Array<ConditionalContextProvider \| ContextPrimitive> | An array of contexts or conditional contexts | -| trackers | Array<string> | The tracker identifiers which the global contexts will be remove from | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.accept.md b/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.accept.md deleted file mode 100644 index 28abb38b1..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.accept.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RuleSet](./browser-tracker.ruleset.md) > [accept](./browser-tracker.ruleset.accept.md) - -## RuleSet.accept property - -Signature: - -```typescript -accept?: Array | string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.md b/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.md deleted file mode 100644 index 8f2c10dae..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RuleSet](./browser-tracker.ruleset.md) - -## RuleSet interface - -A ruleset has accept or reject properties that contain rules for matching Iglu schema URIs - -Signature: - -```typescript -interface RuleSet -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [accept?](./browser-tracker.ruleset.accept.md) | Array<string> \| string | (Optional) | -| [reject?](./browser-tracker.ruleset.reject.md) | Array<string> \| string | (Optional) | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.reject.md b/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.reject.md deleted file mode 100644 index 9e2266217..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.ruleset.reject.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RuleSet](./browser-tracker.ruleset.md) > [reject](./browser-tracker.ruleset.reject.md) - -## RuleSet.reject property - -Signature: - -```typescript -reject?: Array | string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.rulesetprovider.md b/trackers/browser-tracker/docs/markdown/browser-tracker.rulesetprovider.md deleted file mode 100644 index e7d01aa97..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.rulesetprovider.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RuleSetProvider](./browser-tracker.rulesetprovider.md) - -## RuleSetProvider type - -A ruleset provider is aa tuple that has two parts: a ruleset and the context primitive(s) If the ruleset allows the current event schema URI, the tracker will attach the context primitive(s) - -Signature: - -```typescript -type RuleSetProvider = [ - RuleSet, - Array | ContextPrimitive -]; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.event.md b/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.event.md deleted file mode 100644 index 872d5408d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SelfDescribingEvent](./browser-tracker.selfdescribingevent.md) > [event](./browser-tracker.selfdescribingevent.event.md) - -## SelfDescribingEvent.event property - -The Self Describing JSON which describes the event - -Signature: - -```typescript -event: SelfDescribingJson; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.md b/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.md deleted file mode 100644 index 4a84a8467..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingevent.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SelfDescribingEvent](./browser-tracker.selfdescribingevent.md) - -## SelfDescribingEvent interface - -A Self Describing Event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema - -Signature: - -```typescript -interface SelfDescribingEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event](./browser-tracker.selfdescribingevent.event.md) | SelfDescribingJson | The Self Describing JSON which describes the event | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingjson.md b/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingjson.md deleted file mode 100644 index 2e11754c5..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.selfdescribingjson.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SelfDescribingJson](./browser-tracker.selfdescribingjson.md) - -## SelfDescribingJson type - -export interface for any Self-Describing JSON such as context or Self Describing events - -Signature: - -```typescript -type SelfDescribingJson = Record> = { - schema: string; - data: T; -}; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setbuffersize.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setbuffersize.md deleted file mode 100644 index d83956412..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setbuffersize.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setBufferSize](./browser-tracker.setbuffersize.md) - -## setBufferSize() function - -Set the buffer size Can be useful if you want to stop batching requests to ensure events start sending closer to event creation - -Signature: - -```typescript -declare function setBufferSize(newBufferSize: number, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| newBufferSize | number | The value with which to update the bufferSize to | -| trackers | Array<string> | The tracker identifiers which will be flushed | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setcollectorurl.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setcollectorurl.md deleted file mode 100644 index 6dd51922b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setcollectorurl.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setCollectorUrl](./browser-tracker.setcollectorurl.md) - -## setCollectorUrl() function - -Specify the Snowplow collector URL. Specific http or https to force it or leave it off to match the website protocol. - -Signature: - -```typescript -declare function setCollectorUrl(collectorUrl: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| collectorUrl | string | The collector URL, with or without protocol | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setcookiepath.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setcookiepath.md deleted file mode 100644 index b0b31007f..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setcookiepath.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setCookiePath](./browser-tracker.setcookiepath.md) - -## setCookiePath() function - -Set first-party cookie path - -Signature: - -```typescript -declare function setCookiePath(path: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | The path which will be used when setting cookies | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setcustomurl.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setcustomurl.md deleted file mode 100644 index 719371053..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setcustomurl.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setCustomUrl](./browser-tracker.setcustomurl.md) - -## setCustomUrl() function - -Override url - -Signature: - -```typescript -declare function setCustomUrl(url: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | Custom URL which will be used as override | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setdocumenttitle.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setdocumenttitle.md deleted file mode 100644 index cda9b483b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setdocumenttitle.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setDocumentTitle](./browser-tracker.setdocumenttitle.md) - -## setDocumentTitle() function - -Override document.title - -Signature: - -```typescript -declare function setDocumentTitle(title: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| title | string | Document title which will be used as override | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md deleted file mode 100644 index 8b1e2487e..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setOptOutCookie](./browser-tracker.setoptoutcookie.md) - -## setOptOutCookie() function - -Sets the opt out cookie. - -Signature: - -```typescript -declare function setOptOutCookie(name?: string | null, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| name | string \| null | of the opt out cookie | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setreferrerurl.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setreferrerurl.md deleted file mode 100644 index 977d62641..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setreferrerurl.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setReferrerUrl](./browser-tracker.setreferrerurl.md) - -## setReferrerUrl() function - -Override referrer - -Signature: - -```typescript -declare function setReferrerUrl(url: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | Custom Referrer which will be used as override | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md deleted file mode 100644 index 1125648b8..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setUserId](./browser-tracker.setuserid.md) - -## setUserId() function - -Set the business-defined user ID for this user. - -Signature: - -```typescript -declare function setUserId(userId?: string | null, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| userId | string \| null | The business-defined user ID | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromcookie.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromcookie.md deleted file mode 100644 index 4488feb9b..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromcookie.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setUserIdFromCookie](./browser-tracker.setuseridfromcookie.md) - -## setUserIdFromCookie() function - -Set the business-defined user ID for this user to the value of a cookie. - -Signature: - -```typescript -declare function setUserIdFromCookie(cookieName: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| cookieName | string | Name of the cookie whose value will be assigned to businessUserId | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromlocation.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromlocation.md deleted file mode 100644 index 6c20f2593..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromlocation.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setUserIdFromLocation](./browser-tracker.setuseridfromlocation.md) - -## setUserIdFromLocation() function - -Set the business-defined user ID for this user using the location querystring. - -Signature: - -```typescript -declare function setUserIdFromLocation(querystringField: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| querystringField | string | Name of a querystring name-value pair | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromreferrer.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromreferrer.md deleted file mode 100644 index 153aac1fa..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setuseridfromreferrer.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setUserIdFromReferrer](./browser-tracker.setuseridfromreferrer.md) - -## setUserIdFromReferrer() function - -Set the business-defined user ID for this user using the referrer querystring. - -Signature: - -```typescript -declare function setUserIdFromReferrer(querystringField: string, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| querystringField | string | Name of a querystring name-value pair | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setvisitorcookietimeout.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setvisitorcookietimeout.md deleted file mode 100644 index ecc8211e0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setvisitorcookietimeout.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [setVisitorCookieTimeout](./browser-tracker.setvisitorcookietimeout.md) - -## setVisitorCookieTimeout() function - -Set visitor cookie timeout (in seconds) - -Signature: - -```typescript -declare function setVisitorCookieTimeout(timeout: number, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| timeout | number | The timeout until cookies will expire | -| trackers | Array<string> | The tracker identifiers which will be configured | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.statestoragestrategy.md b/trackers/browser-tracker/docs/markdown/browser-tracker.statestoragestrategy.md deleted file mode 100644 index 9c0de57d0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.statestoragestrategy.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StateStorageStrategy](./browser-tracker.statestoragestrategy.md) - -## StateStorageStrategy type - -Signature: - -```typescript -type StateStorageStrategy = "cookieAndLocalStorage" | "cookie" | "localStorage" | "none"; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.action.md b/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.action.md deleted file mode 100644 index 8193e5457..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.action.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [action](./browser-tracker.structuredevent.action.md) - -## StructuredEvent.action property - -Signature: - -```typescript -action: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.category.md b/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.category.md deleted file mode 100644 index d1866c275..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.category.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [category](./browser-tracker.structuredevent.category.md) - -## StructuredEvent.category property - -Signature: - -```typescript -category: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.label.md b/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.label.md deleted file mode 100644 index c11495ba8..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.label.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [label](./browser-tracker.structuredevent.label.md) - -## StructuredEvent.label property - -Signature: - -```typescript -label?: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.md b/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.md deleted file mode 100644 index 3dcec4e55..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) - -## StructuredEvent interface - -A Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. - -Signature: - -```typescript -interface StructuredEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action](./browser-tracker.structuredevent.action.md) | string | | -| [category](./browser-tracker.structuredevent.category.md) | string | | -| [label?](./browser-tracker.structuredevent.label.md) | string | (Optional) | -| [property?](./browser-tracker.structuredevent.property.md) | string | (Optional) | -| [value?](./browser-tracker.structuredevent.value.md) | number | (Optional) | - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.property.md b/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.property.md deleted file mode 100644 index 699772914..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.property.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [property](./browser-tracker.structuredevent.property.md) - -## StructuredEvent.property property - -Signature: - -```typescript -property?: string; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.value.md b/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.value.md deleted file mode 100644 index e9a0e1c78..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.structuredevent.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [value](./browser-tracker.structuredevent.value.md) - -## StructuredEvent.value property - -Signature: - -```typescript -value?: number; -``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md deleted file mode 100644 index b0f36777d..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md +++ /dev/null @@ -1,59 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrackerConfiguration](./browser-tracker.trackerconfiguration.md) - -## TrackerConfiguration type - -The configuration object for initialising the tracker - -Signature: - -```typescript -type TrackerConfiguration = { - encodeBase64?: boolean; - cookieDomain?: string; - cookieName?: string; - cookieSameSite?: CookieSameSite; - cookieSecure?: boolean; - cookieLifetime?: number; - withCredentials?: boolean; - sessionCookieTimeout?: number; - appId?: string; - platform?: Platform; - respectDoNotTrack?: boolean; - eventMethod?: EventMethod; - postPath?: string; - useStm?: boolean; - bufferSize?: number; - crossDomainLinker?: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean; - maxPostBytes?: number; - maxGetBytes?: number; - discoverRootDomain?: boolean; - stateStorageStrategy?: StateStorageStrategy; - maxLocalStorageQueueSize?: number; - resetActivityTrackingOnPageView?: boolean; - connectionTimeout?: number; - anonymousTracking?: AnonymousTrackingOptions; - contexts?: BuiltInContexts; - plugins?: Array; - customHeaders?: Record; - retryStatusCodes?: number[]; - dontRetryStatusCodes?: number[]; - onSessionUpdateCallback?: (updatedSession: ClientSession) => void; - idService?: string; -}; -``` - -## Example - - -``` -newTracker('sp1', 'collector.my-website.com', { - appId: 'my-app-id', - platform: 'web', - plugins: [ PerformanceTimingPlugin(), AdTrackingPlugin() ], - stateStorageStrategy: 'cookieAndLocalStorage' -}); - -``` - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.trackpageview.md b/trackers/browser-tracker/docs/markdown/browser-tracker.trackpageview.md deleted file mode 100644 index 51118d1ee..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.trackpageview.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [trackPageView](./browser-tracker.trackpageview.md) - -## trackPageView() function - -Track a visit to a web page - -Signature: - -```typescript -declare function trackPageView(event?: PageViewEvent & CommonEventProperties, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | PageViewEvent & CommonEventProperties | The Page View Event properties | -| trackers | Array<string> | The tracker identifiers which the event will be sent to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.trackselfdescribingevent.md b/trackers/browser-tracker/docs/markdown/browser-tracker.trackselfdescribingevent.md deleted file mode 100644 index 9cbd522bc..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.trackselfdescribingevent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [trackSelfDescribingEvent](./browser-tracker.trackselfdescribingevent.md) - -## trackSelfDescribingEvent() function - -Track a self-describing event happening on this page. A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema - -Signature: - -```typescript -declare function trackSelfDescribingEvent(event: SelfDescribingEvent & CommonEventProperties, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SelfDescribingEvent & CommonEventProperties | The event information | -| trackers | Array<string> | The tracker identifiers which the event will be sent to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.trackstructevent.md b/trackers/browser-tracker/docs/markdown/browser-tracker.trackstructevent.md deleted file mode 100644 index 78aa6efc3..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.trackstructevent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [trackStructEvent](./browser-tracker.trackstructevent.md) - -## trackStructEvent() function - -Track a structured event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. - -Signature: - -```typescript -declare function trackStructEvent(event: StructuredEvent & CommonEventProperties, trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | StructuredEvent & CommonEventProperties | The Structured Event properties | -| trackers | Array<string> | The tracker identifiers which the event will be sent to | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.updatepageactivity.md b/trackers/browser-tracker/docs/markdown/browser-tracker.updatepageactivity.md deleted file mode 100644 index 35145f5e7..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.updatepageactivity.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [updatePageActivity](./browser-tracker.updatepageactivity.md) - -## updatePageActivity() function - -Triggers the activityHandler manually to allow external user defined activity. i.e. While watching a video - -Signature: - -```typescript -declare function updatePageActivity(trackers?: Array): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trackers | Array<string> | The tracker identifiers which will be updated | - -Returns: - -void - diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.version.md b/trackers/browser-tracker/docs/markdown/browser-tracker.version.md deleted file mode 100644 index b5a5925d0..000000000 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [version](./browser-tracker.version.md) - -## version variable - -Signature: - -```typescript -version: string -``` diff --git a/trackers/browser-tracker/docs/markdown/index.md b/trackers/browser-tracker/docs/markdown/index.md deleted file mode 100644 index 491a423d2..000000000 --- a/trackers/browser-tracker/docs/markdown/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [@snowplow/browser-tracker](./browser-tracker.md) | | - diff --git a/trackers/node-tracker/docs/markdown/index.md b/trackers/node-tracker/docs/markdown/index.md deleted file mode 100644 index 87f8bb7e7..000000000 --- a/trackers/node-tracker/docs/markdown/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [@snowplow/node-tracker](./node-tracker.md) | | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.advertiserid.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.advertiserid.md deleted file mode 100644 index 3e5e1c1f2..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.advertiserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [advertiserId](./node-tracker.adclickevent.advertiserid.md) - -## AdClickEvent.advertiserId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -advertiserId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.bannerid.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.bannerid.md deleted file mode 100644 index 79afd60f4..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.bannerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [bannerId](./node-tracker.adclickevent.bannerid.md) - -## AdClickEvent.bannerId property - -Identifier for the ad banner being displayed - -Signature: - -```typescript -bannerId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.campaignid.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.campaignid.md deleted file mode 100644 index 4a067d9d9..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.campaignid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [campaignId](./node-tracker.adclickevent.campaignid.md) - -## AdClickEvent.campaignId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -campaignId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.clickid.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.clickid.md deleted file mode 100644 index 85816030e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.clickid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [clickId](./node-tracker.adclickevent.clickid.md) - -## AdClickEvent.clickId property - -Identifier for the particular click instance - -Signature: - -```typescript -clickId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.cost.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.cost.md deleted file mode 100644 index 18c8f7a07..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [cost](./node-tracker.adclickevent.cost.md) - -## AdClickEvent.cost property - -Advertisement cost - -Signature: - -```typescript -cost?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.costmodel.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.costmodel.md deleted file mode 100644 index d568b747c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.costmodel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [costModel](./node-tracker.adclickevent.costmodel.md) - -## AdClickEvent.costModel property - -The cost model for the campaign - -Signature: - -```typescript -costModel?: "cpa" | "cpc" | "cpm"; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.impressionid.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.impressionid.md deleted file mode 100644 index 8af82e525..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.impressionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [impressionId](./node-tracker.adclickevent.impressionid.md) - -## AdClickEvent.impressionId property - -Identifier for the particular impression instance - -Signature: - -```typescript -impressionId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md deleted file mode 100644 index f7b092d92..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) - -## AdClickEvent interface - -An Ad Click Event Used to track an advertisement click - -Signature: - -```typescript -interface AdClickEvent -``` - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [advertiserId?](./node-tracker.adclickevent.advertiserid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [bannerId?](./node-tracker.adclickevent.bannerid.md) | string | (Optional) Identifier for the ad banner being displayed | -| [campaignId?](./node-tracker.adclickevent.campaignid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [clickId?](./node-tracker.adclickevent.clickid.md) | string | (Optional) Identifier for the particular click instance | -| [cost?](./node-tracker.adclickevent.cost.md) | number | (Optional) Advertisement cost | -| [costModel?](./node-tracker.adclickevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | (Optional) The cost model for the campaign | -| [impressionId?](./node-tracker.adclickevent.impressionid.md) | string | (Optional) Identifier for the particular impression instance | -| [targetUrl](./node-tracker.adclickevent.targeturl.md) | string | The destination URL of the advertisement | -| [zoneId?](./node-tracker.adclickevent.zoneid.md) | string | (Optional) Identifier for the zone where the ad banner is located | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.targeturl.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.targeturl.md deleted file mode 100644 index 7da8c1ed8..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.targeturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [targetUrl](./node-tracker.adclickevent.targeturl.md) - -## AdClickEvent.targetUrl property - -The destination URL of the advertisement - -Signature: - -```typescript -targetUrl: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.zoneid.md b/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.zoneid.md deleted file mode 100644 index 678870cf5..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adclickevent.zoneid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdClickEvent](./node-tracker.adclickevent.md) > [zoneId](./node-tracker.adclickevent.zoneid.md) - -## AdClickEvent.zoneId property - -Identifier for the zone where the ad banner is located - -Signature: - -```typescript -zoneId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.action.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.action.md deleted file mode 100644 index 7a4372493..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.action.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [action](./node-tracker.adconversionevent.action.md) - -## AdConversionEvent.action property - -The type of user interaction e.g. 'purchase' - -Signature: - -```typescript -action?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.advertiserid.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.advertiserid.md deleted file mode 100644 index 442ca64d4..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.advertiserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [advertiserId](./node-tracker.adconversionevent.advertiserid.md) - -## AdConversionEvent.advertiserId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -advertiserId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.campaignid.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.campaignid.md deleted file mode 100644 index 052760288..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.campaignid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [campaignId](./node-tracker.adconversionevent.campaignid.md) - -## AdConversionEvent.campaignId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -campaignId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.category.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.category.md deleted file mode 100644 index 993a9384b..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [category](./node-tracker.adconversionevent.category.md) - -## AdConversionEvent.category property - -Conversion category - -Signature: - -```typescript -category?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.conversionid.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.conversionid.md deleted file mode 100644 index 714874194..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.conversionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [conversionId](./node-tracker.adconversionevent.conversionid.md) - -## AdConversionEvent.conversionId property - -Identifier for the particular conversion instance - -Signature: - -```typescript -conversionId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.cost.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.cost.md deleted file mode 100644 index 1745c1116..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [cost](./node-tracker.adconversionevent.cost.md) - -## AdConversionEvent.cost property - -Advertisement cost - -Signature: - -```typescript -cost?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.costmodel.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.costmodel.md deleted file mode 100644 index 60ad5c84f..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.costmodel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [costModel](./node-tracker.adconversionevent.costmodel.md) - -## AdConversionEvent.costModel property - -The cost model for the campaign - -Signature: - -```typescript -costModel?: "cpa" | "cpc" | "cpm"; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.initialvalue.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.initialvalue.md deleted file mode 100644 index fc4d27d82..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.initialvalue.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [initialValue](./node-tracker.adconversionevent.initialvalue.md) - -## AdConversionEvent.initialValue property - -How much the conversion is initially worth - -Signature: - -```typescript -initialValue?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md deleted file mode 100644 index c9fb83e7c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) - -## AdConversionEvent interface - -An Ad Conversion Event Used to track an advertisement click - -Signature: - -```typescript -interface AdConversionEvent -``` - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action?](./node-tracker.adconversionevent.action.md) | string | (Optional) The type of user interaction e.g. 'purchase' | -| [advertiserId?](./node-tracker.adconversionevent.advertiserid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [campaignId?](./node-tracker.adconversionevent.campaignid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [category?](./node-tracker.adconversionevent.category.md) | string | (Optional) Conversion category | -| [conversionId?](./node-tracker.adconversionevent.conversionid.md) | string | (Optional) Identifier for the particular conversion instance | -| [cost?](./node-tracker.adconversionevent.cost.md) | number | (Optional) Advertisement cost | -| [costModel?](./node-tracker.adconversionevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | (Optional) The cost model for the campaign | -| [initialValue?](./node-tracker.adconversionevent.initialvalue.md) | number | (Optional) How much the conversion is initially worth | -| [property?](./node-tracker.adconversionevent.property.md) | string | (Optional) Describes the object of the conversion | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.property.md b/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.property.md deleted file mode 100644 index 620fbd221..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adconversionevent.property.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdConversionEvent](./node-tracker.adconversionevent.md) > [property](./node-tracker.adconversionevent.property.md) - -## AdConversionEvent.property property - -Describes the object of the conversion - -Signature: - -```typescript -property?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.category.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.category.md deleted file mode 100644 index c673cc6da..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [category](./node-tracker.addtocartevent.category.md) - -## AddToCartEvent.category property - -The category of the product - -Signature: - -```typescript -category?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.currency.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.currency.md deleted file mode 100644 index e039e4930..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [currency](./node-tracker.addtocartevent.currency.md) - -## AddToCartEvent.currency property - -The currency of the product - -Signature: - -```typescript -currency?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.md deleted file mode 100644 index db24e8413..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) - -## AddToCartEvent interface - -An Add To Cart Event For tracking users adding items from a cart on an ecommerce site. - -Signature: - -```typescript -interface AddToCartEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./node-tracker.addtocartevent.category.md) | string | (Optional) The category of the product | -| [currency?](./node-tracker.addtocartevent.currency.md) | string | (Optional) The currency of the product | -| [name?](./node-tracker.addtocartevent.name.md) | string | (Optional) The name of the product | -| [quantity](./node-tracker.addtocartevent.quantity.md) | number | The number added to the cart | -| [sku](./node-tracker.addtocartevent.sku.md) | string | A Product Stock Keeping Unit (SKU) | -| [unitPrice?](./node-tracker.addtocartevent.unitprice.md) | number | (Optional) The price of the product | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.name.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.name.md deleted file mode 100644 index ee05beaa6..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [name](./node-tracker.addtocartevent.name.md) - -## AddToCartEvent.name property - -The name of the product - -Signature: - -```typescript -name?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.quantity.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.quantity.md deleted file mode 100644 index faa389463..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.quantity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [quantity](./node-tracker.addtocartevent.quantity.md) - -## AddToCartEvent.quantity property - -The number added to the cart - -Signature: - -```typescript -quantity: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.sku.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.sku.md deleted file mode 100644 index 7812ee51e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.sku.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [sku](./node-tracker.addtocartevent.sku.md) - -## AddToCartEvent.sku property - -A Product Stock Keeping Unit (SKU) - -Signature: - -```typescript -sku: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.unitprice.md b/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.unitprice.md deleted file mode 100644 index 1004e0b41..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.addtocartevent.unitprice.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AddToCartEvent](./node-tracker.addtocartevent.md) > [unitPrice](./node-tracker.addtocartevent.unitprice.md) - -## AddToCartEvent.unitPrice property - -The price of the product - -Signature: - -```typescript -unitPrice?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.advertiserid.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.advertiserid.md deleted file mode 100644 index 714669fd1..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.advertiserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [advertiserId](./node-tracker.adimpressionevent.advertiserid.md) - -## AdImpressionEvent.advertiserId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -advertiserId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.bannerid.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.bannerid.md deleted file mode 100644 index 6abc38e9c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.bannerid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [bannerId](./node-tracker.adimpressionevent.bannerid.md) - -## AdImpressionEvent.bannerId property - -Identifier for the ad banner being displayed - -Signature: - -```typescript -bannerId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.campaignid.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.campaignid.md deleted file mode 100644 index 295fd04d9..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.campaignid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [campaignId](./node-tracker.adimpressionevent.campaignid.md) - -## AdImpressionEvent.campaignId property - -Identifier for the advertiser which the campaign belongs to - -Signature: - -```typescript -campaignId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.cost.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.cost.md deleted file mode 100644 index a44fd3ac0..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [cost](./node-tracker.adimpressionevent.cost.md) - -## AdImpressionEvent.cost property - -Advertisement cost - -Signature: - -```typescript -cost?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.costmodel.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.costmodel.md deleted file mode 100644 index 976c9370a..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.costmodel.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [costModel](./node-tracker.adimpressionevent.costmodel.md) - -## AdImpressionEvent.costModel property - -The cost model for the campaign - -Signature: - -```typescript -costModel?: "cpa" | "cpc" | "cpm"; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.impressionid.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.impressionid.md deleted file mode 100644 index 1085dc7f1..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.impressionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [impressionId](./node-tracker.adimpressionevent.impressionid.md) - -## AdImpressionEvent.impressionId property - -Identifier for the particular impression instance - -Signature: - -```typescript -impressionId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md deleted file mode 100644 index b1e09a8c9..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) - -## AdImpressionEvent interface - -An Ad Impression Event Used to track an advertisement impression - -Signature: - -```typescript -interface AdImpressionEvent -``` - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [advertiserId?](./node-tracker.adimpressionevent.advertiserid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [bannerId?](./node-tracker.adimpressionevent.bannerid.md) | string | (Optional) Identifier for the ad banner being displayed | -| [campaignId?](./node-tracker.adimpressionevent.campaignid.md) | string | (Optional) Identifier for the advertiser which the campaign belongs to | -| [cost?](./node-tracker.adimpressionevent.cost.md) | number | (Optional) Advertisement cost | -| [costModel?](./node-tracker.adimpressionevent.costmodel.md) | "cpa" \| "cpc" \| "cpm" | (Optional) The cost model for the campaign | -| [impressionId?](./node-tracker.adimpressionevent.impressionid.md) | string | (Optional) Identifier for the particular impression instance | -| [targetUrl?](./node-tracker.adimpressionevent.targeturl.md) | string | (Optional) The destination URL of the advertisement | -| [zoneId?](./node-tracker.adimpressionevent.zoneid.md) | string | (Optional) Identifier for the zone where the ad banner is located | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.targeturl.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.targeturl.md deleted file mode 100644 index 969998014..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.targeturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [targetUrl](./node-tracker.adimpressionevent.targeturl.md) - -## AdImpressionEvent.targetUrl property - -The destination URL of the advertisement - -Signature: - -```typescript -targetUrl?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.zoneid.md b/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.zoneid.md deleted file mode 100644 index 5a0f779e0..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.adimpressionevent.zoneid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [AdImpressionEvent](./node-tracker.adimpressionevent.md) > [zoneId](./node-tracker.adimpressionevent.zoneid.md) - -## AdImpressionEvent.zoneId property - -Identifier for the zone where the ad banner is located - -Signature: - -```typescript -zoneId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md b/trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md deleted file mode 100644 index 785a252c5..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildadclick.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAdClick](./node-tracker.buildadclick.md) - -## buildAdClick() function - -Build a Ad Click Event Used to track an advertisement click - -Signature: - -```typescript -declare function buildAdClick(event: AdClickEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AdClickEvent | Contains the properties for the Ad Click event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md b/trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md deleted file mode 100644 index 03f7a9eff..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildadconversion.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAdConversion](./node-tracker.buildadconversion.md) - -## buildAdConversion() function - -Build a Ad Conversion Event Used to track an advertisement click - -Signature: - -```typescript -declare function buildAdConversion(event: AdConversionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AdConversionEvent | Contains the properties for the Ad Conversion event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md b/trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md deleted file mode 100644 index d03b5d54f..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildaddtocart.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAddToCart](./node-tracker.buildaddtocart.md) - -## buildAddToCart() function - -Build a Add To Cart Event For tracking users adding items from a cart on an ecommerce site. - -Signature: - -```typescript -declare function buildAddToCart(event: AddToCartEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AddToCartEvent | Contains the properties for the Add To Cart event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md b/trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md deleted file mode 100644 index 69913bd47..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildadimpression.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildAdImpression](./node-tracker.buildadimpression.md) - -## buildAdImpression() function - -Build a Ad Impression Event Used to track an advertisement impression - -Signature: - -```typescript -declare function buildAdImpression(event: AdImpressionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | AdImpressionEvent | Contains the properties for the Ad Impression event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - -## Remarks - -If you provide the cost field, you must also provide one of 'cpa', 'cpc', and 'cpm' for the costModel field. - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md b/trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md deleted file mode 100644 index da5d9a077..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildconsentgranted.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildConsentGranted](./node-tracker.buildconsentgranted.md) - -## buildConsentGranted() function - -Build a Consent Granted Event Used for tracking when a user grants their consent - -Signature: - -```typescript -declare function buildConsentGranted(event: ConsentGrantedEvent): { - event: PayloadBuilder; - context: { - schema: string; - data: Record; - }[]; -}; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | ConsentGrantedEvent | Contains the properties for the Consent Granted event | - -Returns: - -{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; } - -An object containing the PayloadBuilder to be sent to and a 'consent\_document' context - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md b/trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md deleted file mode 100644 index dc59cff79..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildconsentwithdrawn.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildConsentWithdrawn](./node-tracker.buildconsentwithdrawn.md) - -## buildConsentWithdrawn() function - -Build a Consent Withdrawn Event Used for tracking when a user withdraws their consent - -Signature: - -```typescript -declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): { - event: PayloadBuilder; - context: { - schema: string; - data: Record; - }[]; -}; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | ConsentWithdrawnEvent | Contains the properties for the Consent Withdrawn event | - -Returns: - -{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; } - -An object containing the PayloadBuilder to be sent to and a 'consent\_document' context - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md b/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md deleted file mode 100644 index 3710ec68c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransaction.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildEcommerceTransaction](./node-tracker.buildecommercetransaction.md) - -## buildEcommerceTransaction() function - -Build an Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a consumer completes a transaction. - -Signature: - -```typescript -declare function buildEcommerceTransaction(event: EcommerceTransactionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | EcommerceTransactionEvent | Contains the properties for the Ecommerce Transactoion event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md b/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md deleted file mode 100644 index 6454fe481..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildecommercetransactionitem.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildEcommerceTransactionItem](./node-tracker.buildecommercetransactionitem.md) - -## buildEcommerceTransactionItem() function - -Build an Ecommerce Transaction Item Event Related to the [buildEcommerceTransaction()](./node-tracker.buildecommercetransaction.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events - -Signature: - -```typescript -declare function buildEcommerceTransactionItem(event: EcommerceTransactionItemEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | EcommerceTransactionItemEvent | Contains the properties for the Ecommerce Transaction Item event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md b/trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md deleted file mode 100644 index 2e85d8821..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildformfocusorchange.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildFormFocusOrChange](./node-tracker.buildformfocusorchange.md) - -## buildFormFocusOrChange() function - -Build a Form Focus or Change Form Event based on schema property When a user focuses on a form element or when a user makes a change to a form element. - -Signature: - -```typescript -declare function buildFormFocusOrChange(event: FormFocusOrChangeEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | FormFocusOrChangeEvent | Contains the properties for the Form Focus or Change Form event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md b/trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md deleted file mode 100644 index 7f25820d9..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildformsubmission.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildFormSubmission](./node-tracker.buildformsubmission.md) - -## buildFormSubmission() function - -Build a Form Submission Event Used to track when a user submits a form - -Signature: - -```typescript -declare function buildFormSubmission(event: FormSubmissionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | FormSubmissionEvent | Contains the properties for the Form Submission event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md b/trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md deleted file mode 100644 index c9e082945..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildlinkclick.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildLinkClick](./node-tracker.buildlinkclick.md) - -## buildLinkClick() function - -Build a Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag - -Signature: - -```typescript -declare function buildLinkClick(event: LinkClickEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | LinkClickEvent | Contains the properties for the Link Click event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md b/trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md deleted file mode 100644 index f72b55146..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildpageping.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildPagePing](./node-tracker.buildpageping.md) - -## buildPagePing() function - -Build a Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view - -Signature: - -```typescript -declare function buildPagePing(event: PagePingEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | PagePingEvent | Contains the properties for the Page Ping event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md b/trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md deleted file mode 100644 index 25a198ad1..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildpageview.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildPageView](./node-tracker.buildpageview.md) - -## buildPageView() function - -Build a Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA). - -Signature: - -```typescript -declare function buildPageView(event: PageViewEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | PageViewEvent | Contains the properties for the Page View event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md b/trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md deleted file mode 100644 index d9aa28129..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildremovefromcart.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildRemoveFromCart](./node-tracker.buildremovefromcart.md) - -## buildRemoveFromCart() function - -Build a Remove From Cart Event For tracking users removing items from a cart on an ecommerce site. - -Signature: - -```typescript -declare function buildRemoveFromCart(event: RemoveFromCartEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | RemoveFromCartEvent | Contains the properties for the Remove From Cart event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md b/trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md deleted file mode 100644 index 8ead82eac..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildscreenview.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildScreenView](./node-tracker.buildscreenview.md) - -## buildScreenView() function - -Build a Scren View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events - -Signature: - -```typescript -declare function buildScreenView(event: ScreenViewEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | ScreenViewEvent | Contains the properties for the Screen View event. One or more properties must be included. | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md b/trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md deleted file mode 100644 index 111b618ae..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildselfdescribingevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildSelfDescribingEvent](./node-tracker.buildselfdescribingevent.md) - -## buildSelfDescribingEvent() function - -Build a self-describing event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema - -Signature: - -```typescript -declare function buildSelfDescribingEvent(event: SelfDescribingEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SelfDescribingEvent | Contains the properties and schema location for the event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md b/trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md deleted file mode 100644 index d974da411..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildsitesearch.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildSiteSearch](./node-tracker.buildsitesearch.md) - -## buildSiteSearch() function - -Build a Site Search Event Used when a user performs a search action on a page - -Signature: - -```typescript -declare function buildSiteSearch(event: SiteSearchEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SiteSearchEvent | Contains the properties for the Site Search event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md b/trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md deleted file mode 100644 index 1fe5f8d23..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildsocialinteraction.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildSocialInteraction](./node-tracker.buildsocialinteraction.md) - -## buildSocialInteraction() function - -Build a Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. - -Signature: - -```typescript -declare function buildSocialInteraction(event: SocialInteractionEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | SocialInteractionEvent | Contains the properties for the Social Interaction event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md b/trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md deleted file mode 100644 index a7d5ce436..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.buildstructevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [buildStructEvent](./node-tracker.buildstructevent.md) - -## buildStructEvent() function - -Build a Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. - -Signature: - -```typescript -declare function buildStructEvent(event: StructuredEvent): PayloadBuilder; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| event | StructuredEvent | Contains the properties for the Structured event | - -Returns: - -PayloadBuilder - -PayloadBuilder to be sent to - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.description.md b/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.description.md deleted file mode 100644 index 5a2897ce7..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [description](./node-tracker.consentgrantedevent.description.md) - -## ConsentGrantedEvent.description property - -Description of the document granting consent - -Signature: - -```typescript -description?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.expiry.md b/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.expiry.md deleted file mode 100644 index 7980124c9..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.expiry.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [expiry](./node-tracker.consentgrantedevent.expiry.md) - -## ConsentGrantedEvent.expiry property - -When the consent expires - -Signature: - -```typescript -expiry?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.id.md b/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.id.md deleted file mode 100644 index e97adbf21..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [id](./node-tracker.consentgrantedevent.id.md) - -## ConsentGrantedEvent.id property - -Identifier for the document granting consent - -Signature: - -```typescript -id: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.md b/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.md deleted file mode 100644 index 9a8ca92aa..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) - -## ConsentGrantedEvent interface - -A Consent Granted Event Used for tracking when a user grants their consent - -Signature: - -```typescript -interface ConsentGrantedEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description?](./node-tracker.consentgrantedevent.description.md) | string | (Optional) Description of the document granting consent | -| [expiry?](./node-tracker.consentgrantedevent.expiry.md) | string | (Optional) When the consent expires | -| [id](./node-tracker.consentgrantedevent.id.md) | string | Identifier for the document granting consent | -| [name?](./node-tracker.consentgrantedevent.name.md) | string | (Optional) Name of the document granting consent | -| [version](./node-tracker.consentgrantedevent.version.md) | string | Version of the document granting consent | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.name.md b/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.name.md deleted file mode 100644 index 2f5c1717c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [name](./node-tracker.consentgrantedevent.name.md) - -## ConsentGrantedEvent.name property - -Name of the document granting consent - -Signature: - -```typescript -name?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.version.md b/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.version.md deleted file mode 100644 index f09fa300e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentgrantedevent.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) > [version](./node-tracker.consentgrantedevent.version.md) - -## ConsentGrantedEvent.version property - -Version of the document granting consent - -Signature: - -```typescript -version: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.all.md b/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.all.md deleted file mode 100644 index 214968a3a..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.all.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [all](./node-tracker.consentwithdrawnevent.all.md) - -## ConsentWithdrawnEvent.all property - -Specifies whether all consent should be withdrawn - -Signature: - -```typescript -all: boolean; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.description.md b/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.description.md deleted file mode 100644 index 721fd25f3..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.description.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [description](./node-tracker.consentwithdrawnevent.description.md) - -## ConsentWithdrawnEvent.description property - -Description of the document withdrawing consent - -Signature: - -```typescript -description?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.id.md b/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.id.md deleted file mode 100644 index 55ce74932..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [id](./node-tracker.consentwithdrawnevent.id.md) - -## ConsentWithdrawnEvent.id property - -Identifier for the document withdrawing consent - -Signature: - -```typescript -id?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.md b/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.md deleted file mode 100644 index 83ea1e980..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) - -## ConsentWithdrawnEvent interface - -A Consent Withdrawn Event Used for tracking when a user withdraws their consent - -Signature: - -```typescript -interface ConsentWithdrawnEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [all](./node-tracker.consentwithdrawnevent.all.md) | boolean | Specifies whether all consent should be withdrawn | -| [description?](./node-tracker.consentwithdrawnevent.description.md) | string | (Optional) Description of the document withdrawing consent | -| [id?](./node-tracker.consentwithdrawnevent.id.md) | string | (Optional) Identifier for the document withdrawing consent | -| [name?](./node-tracker.consentwithdrawnevent.name.md) | string | (Optional) Name of the document withdrawing consent | -| [version?](./node-tracker.consentwithdrawnevent.version.md) | string | (Optional) Version of the document withdrawing consent | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.name.md b/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.name.md deleted file mode 100644 index eb924a795..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [name](./node-tracker.consentwithdrawnevent.name.md) - -## ConsentWithdrawnEvent.name property - -Name of the document withdrawing consent - -Signature: - -```typescript -name?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.version.md b/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.version.md deleted file mode 100644 index 557356eca..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.consentwithdrawnevent.version.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) > [version](./node-tracker.consentwithdrawnevent.version.md) - -## ConsentWithdrawnEvent.version property - -Version of the document withdrawing consent - -Signature: - -```typescript -version?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.event.md b/trackers/node-tracker/docs/markdown/node-tracker.contextevent.event.md deleted file mode 100644 index e7e6dacb8..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) > [event](./node-tracker.contextevent.event.md) - -## ContextEvent.event property - -The event payload - -Signature: - -```typescript -event: Payload; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventschema.md b/trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventschema.md deleted file mode 100644 index 6dfc354d8..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventschema.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) > [eventSchema](./node-tracker.contextevent.eventschema.md) - -## ContextEvent.eventSchema property - -The event schema where one is available, or empty string - -Signature: - -```typescript -eventSchema: string; -``` - -## Example - -'iglu:com.snowplowanalytics.snowplow/ad\_impression/jsonschema/1-0-0' - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventtype.md b/trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventtype.md deleted file mode 100644 index ba6cc94cd..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.eventtype.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) > [eventType](./node-tracker.contextevent.eventtype.md) - -## ContextEvent.eventType property - -The event type - -Signature: - -```typescript -eventType: string; -``` - -## Example - -'page\_view' - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.md b/trackers/node-tracker/docs/markdown/node-tracker.contextevent.md deleted file mode 100644 index 1c30d7d74..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.contextevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextEvent](./node-tracker.contextevent.md) - -## ContextEvent interface - -Argument for [ContextGenerator](./node-tracker.contextgenerator.md) and [ContextFilter](./node-tracker.contextfilter.md) callback - -Signature: - -```typescript -interface ContextEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event](./node-tracker.contextevent.event.md) | Payload | The event payload | -| [eventSchema](./node-tracker.contextevent.eventschema.md) | string | The event schema where one is available, or empty string | -| [eventType](./node-tracker.contextevent.eventtype.md) | string | The event type | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.contextfilter.md b/trackers/node-tracker/docs/markdown/node-tracker.contextfilter.md deleted file mode 100644 index 6285a22da..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.contextfilter.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextFilter](./node-tracker.contextfilter.md) - -## ContextFilter type - -A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event - -Signature: - -```typescript -type ContextFilter = (args?: ContextEvent) => boolean; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.contextgenerator.md b/trackers/node-tracker/docs/markdown/node-tracker.contextgenerator.md deleted file mode 100644 index 1e2764916..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.contextgenerator.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ContextGenerator](./node-tracker.contextgenerator.md) - -## ContextGenerator type - -A context generator is a user-supplied callback that is evaluated for each event to allow an additional context to be dynamically attached to the event - -Signature: - -```typescript -type ContextGenerator = (args?: ContextEvent) => SelfDescribingJson | SelfDescribingJson[] | undefined; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.base64.md b/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.base64.md deleted file mode 100644 index fe7094e46..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.base64.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) > [base64](./node-tracker.coreconfiguration.base64.md) - -## CoreConfiguration.base64 property - -Signature: - -```typescript -base64?: boolean; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.callback.md b/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.callback.md deleted file mode 100644 index 56c5a063a..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.callback.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) > [callback](./node-tracker.coreconfiguration.callback.md) - -## CoreConfiguration.callback property - -Signature: - -```typescript -callback?: (PayloadData: PayloadBuilder) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.coreplugins.md b/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.coreplugins.md deleted file mode 100644 index 99bbd569d..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.coreplugins.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) > [corePlugins](./node-tracker.coreconfiguration.coreplugins.md) - -## CoreConfiguration.corePlugins property - -Signature: - -```typescript -corePlugins?: Array; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.md b/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.md deleted file mode 100644 index 1db83da79..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreconfiguration.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CoreConfiguration](./node-tracker.coreconfiguration.md) - -## CoreConfiguration interface - -The configuration object for the tracker core library - -Signature: - -```typescript -interface CoreConfiguration -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [base64?](./node-tracker.coreconfiguration.base64.md) | boolean | (Optional) | -| [callback?](./node-tracker.coreconfiguration.callback.md) | (PayloadData: PayloadBuilder) => void | (Optional) | -| [corePlugins?](./node-tracker.coreconfiguration.coreplugins.md) | Array<CorePlugin> | (Optional) | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md deleted file mode 100644 index 0af3894f6..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.activatecoreplugin.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [activateCorePlugin](./node-tracker.coreplugin.activatecoreplugin.md) - -## CorePlugin.activateCorePlugin property - -Called when the plugin is initialised during the trackerCore construction - -Signature: - -```typescript -activateCorePlugin?: (core: TrackerCore) => void; -``` - -## Remarks - -Use to capture the specific core instance for each instance of a core plugin - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.aftertrack.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.aftertrack.md deleted file mode 100644 index e379642e3..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.aftertrack.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [afterTrack](./node-tracker.coreplugin.aftertrack.md) - -## CorePlugin.afterTrack property - -Called just after the trackerCore callback fires - -Signature: - -```typescript -afterTrack?: (payload: Payload) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.beforetrack.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.beforetrack.md deleted file mode 100644 index da2f00118..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.beforetrack.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [beforeTrack](./node-tracker.coreplugin.beforetrack.md) - -## CorePlugin.beforeTrack property - -Called just before the trackerCore callback fires - -Signature: - -```typescript -beforeTrack?: (payloadBuilder: PayloadBuilder) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.contexts.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.contexts.md deleted file mode 100644 index 9ae49b41e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.contexts.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [contexts](./node-tracker.coreplugin.contexts.md) - -## CorePlugin.contexts property - -Called when constructing the context for each event Useful for adding additional context to events - -Signature: - -```typescript -contexts?: () => SelfDescribingJson[]; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.logger.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.logger.md deleted file mode 100644 index d2430b4c0..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.logger.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) > [logger](./node-tracker.coreplugin.logger.md) - -## CorePlugin.logger property - -Passed a logger instance which can be used to send log information to the active logger - -Signature: - -```typescript -logger?: (logger: Logger) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md b/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md deleted file mode 100644 index 2106026ce..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.coreplugin.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [CorePlugin](./node-tracker.coreplugin.md) - -## CorePlugin interface - -Interface which defines Core Plugins - -Signature: - -```typescript -interface CorePlugin -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [activateCorePlugin?](./node-tracker.coreplugin.activatecoreplugin.md) | (core: TrackerCore) => void | (Optional) Called when the plugin is initialised during the trackerCore construction | -| [afterTrack?](./node-tracker.coreplugin.aftertrack.md) | (payload: Payload) => void | (Optional) Called just after the trackerCore callback fires | -| [beforeTrack?](./node-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) => void | (Optional) Called just before the trackerCore callback fires | -| [contexts?](./node-tracker.coreplugin.contexts.md) | () => SelfDescribingJson\[\] | (Optional) Called when constructing the context for each event Useful for adding additional context to events | -| [logger?](./node-tracker.coreplugin.logger.md) | (logger: Logger) => void | (Optional) Passed a logger instance which can be used to send log information to the active logger | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.affiliation.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.affiliation.md deleted file mode 100644 index d994df3ee..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.affiliation.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [affiliation](./node-tracker.ecommercetransactionevent.affiliation.md) - -## EcommerceTransactionEvent.affiliation property - -Transaction affiliation (e.g. store where sale took place) - -Signature: - -```typescript -affiliation?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.city.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.city.md deleted file mode 100644 index b8782e255..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.city.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [city](./node-tracker.ecommercetransactionevent.city.md) - -## EcommerceTransactionEvent.city property - -Delivery address, city - -Signature: - -```typescript -city?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.country.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.country.md deleted file mode 100644 index cadfddea4..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.country.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [country](./node-tracker.ecommercetransactionevent.country.md) - -## EcommerceTransactionEvent.country property - -Delivery address, country - -Signature: - -```typescript -country?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.currency.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.currency.md deleted file mode 100644 index dc6658910..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [currency](./node-tracker.ecommercetransactionevent.currency.md) - -## EcommerceTransactionEvent.currency property - -Currency of the transaction - -Signature: - -```typescript -currency?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.md deleted file mode 100644 index 4ad6238cc..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) - -## EcommerceTransactionEvent interface - -An Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a customer completes a transaction. - -Signature: - -```typescript -interface EcommerceTransactionEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [affiliation?](./node-tracker.ecommercetransactionevent.affiliation.md) | string | (Optional) Transaction affiliation (e.g. store where sale took place) | -| [city?](./node-tracker.ecommercetransactionevent.city.md) | string | (Optional) Delivery address, city | -| [country?](./node-tracker.ecommercetransactionevent.country.md) | string | (Optional) Delivery address, country | -| [currency?](./node-tracker.ecommercetransactionevent.currency.md) | string | (Optional) Currency of the transaction | -| [orderId](./node-tracker.ecommercetransactionevent.orderid.md) | string | An identifier for the order | -| [shipping?](./node-tracker.ecommercetransactionevent.shipping.md) | number | (Optional) The amount of shipping costs for this transaction | -| [state?](./node-tracker.ecommercetransactionevent.state.md) | string | (Optional) Delivery address, state | -| [tax?](./node-tracker.ecommercetransactionevent.tax.md) | number | (Optional) The amount of tax on the transaction | -| [total](./node-tracker.ecommercetransactionevent.total.md) | number | The total value of the order | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.orderid.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.orderid.md deleted file mode 100644 index d18cc0704..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.orderid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [orderId](./node-tracker.ecommercetransactionevent.orderid.md) - -## EcommerceTransactionEvent.orderId property - -An identifier for the order - -Signature: - -```typescript -orderId: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.shipping.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.shipping.md deleted file mode 100644 index 2c15dbec8..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.shipping.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [shipping](./node-tracker.ecommercetransactionevent.shipping.md) - -## EcommerceTransactionEvent.shipping property - -The amount of shipping costs for this transaction - -Signature: - -```typescript -shipping?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.state.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.state.md deleted file mode 100644 index ab136f265..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [state](./node-tracker.ecommercetransactionevent.state.md) - -## EcommerceTransactionEvent.state property - -Delivery address, state - -Signature: - -```typescript -state?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.tax.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.tax.md deleted file mode 100644 index 59d0f6c6f..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.tax.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [tax](./node-tracker.ecommercetransactionevent.tax.md) - -## EcommerceTransactionEvent.tax property - -The amount of tax on the transaction - -Signature: - -```typescript -tax?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.total.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.total.md deleted file mode 100644 index eec8b36bb..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionevent.total.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) > [total](./node-tracker.ecommercetransactionevent.total.md) - -## EcommerceTransactionEvent.total property - -The total value of the order - -Signature: - -```typescript -total: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.category.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.category.md deleted file mode 100644 index 565961252..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [category](./node-tracker.ecommercetransactionitemevent.category.md) - -## EcommerceTransactionItemEvent.category property - -The category the product belongs to - -Signature: - -```typescript -category?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.currency.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.currency.md deleted file mode 100644 index 9054c2e57..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [currency](./node-tracker.ecommercetransactionitemevent.currency.md) - -## EcommerceTransactionItemEvent.currency property - -The currency of the product for the transaction - -Signature: - -```typescript -currency?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.md deleted file mode 100644 index 726b48866..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) - -## EcommerceTransactionItemEvent interface - -An Ecommerce Transaction Item Related to the [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events - -Signature: - -```typescript -interface EcommerceTransactionItemEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./node-tracker.ecommercetransactionitemevent.category.md) | string | (Optional) The category the product belongs to | -| [currency?](./node-tracker.ecommercetransactionitemevent.currency.md) | string | (Optional) The currency of the product for the transaction | -| [name?](./node-tracker.ecommercetransactionitemevent.name.md) | string | (Optional) The name of the product | -| [orderId](./node-tracker.ecommercetransactionitemevent.orderid.md) | string | An identifier for the order | -| [price](./node-tracker.ecommercetransactionitemevent.price.md) | number | The price of the product | -| [quantity?](./node-tracker.ecommercetransactionitemevent.quantity.md) | number | (Optional) The quanity of this product within the transaction | -| [sku](./node-tracker.ecommercetransactionitemevent.sku.md) | string | A Product Stock Keeping Unit (SKU) | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.name.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.name.md deleted file mode 100644 index ea68d4a77..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [name](./node-tracker.ecommercetransactionitemevent.name.md) - -## EcommerceTransactionItemEvent.name property - -The name of the product - -Signature: - -```typescript -name?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.orderid.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.orderid.md deleted file mode 100644 index e20a39c00..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.orderid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [orderId](./node-tracker.ecommercetransactionitemevent.orderid.md) - -## EcommerceTransactionItemEvent.orderId property - -An identifier for the order - -Signature: - -```typescript -orderId: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.price.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.price.md deleted file mode 100644 index 9cf674c15..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.price.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [price](./node-tracker.ecommercetransactionitemevent.price.md) - -## EcommerceTransactionItemEvent.price property - -The price of the product - -Signature: - -```typescript -price: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.quantity.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.quantity.md deleted file mode 100644 index 433b60092..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.quantity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [quantity](./node-tracker.ecommercetransactionitemevent.quantity.md) - -## EcommerceTransactionItemEvent.quantity property - -The quanity of this product within the transaction - -Signature: - -```typescript -quantity?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.sku.md b/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.sku.md deleted file mode 100644 index 3178268ed..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.ecommercetransactionitemevent.sku.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) > [sku](./node-tracker.ecommercetransactionitemevent.sku.md) - -## EcommerceTransactionItemEvent.sku property - -A Product Stock Keeping Unit (SKU) - -Signature: - -```typescript -sku: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.emitter.flush.md b/trackers/node-tracker/docs/markdown/node-tracker.emitter.flush.md deleted file mode 100644 index e548ed1d5..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.emitter.flush.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [flush](./node-tracker.emitter.flush.md) - -## Emitter.flush property - -Signature: - -```typescript -flush: () => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.emitter.input.md b/trackers/node-tracker/docs/markdown/node-tracker.emitter.input.md deleted file mode 100644 index f37d04b76..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.emitter.input.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) > [input](./node-tracker.emitter.input.md) - -## Emitter.input property - -Signature: - -```typescript -input: (payload: Payload) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.emitter.md b/trackers/node-tracker/docs/markdown/node-tracker.emitter.md deleted file mode 100644 index bcc399222..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.emitter.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Emitter](./node-tracker.emitter.md) - -## Emitter interface - -Signature: - -```typescript -interface Emitter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [flush](./node-tracker.emitter.flush.md) | () => void | | -| [input](./node-tracker.emitter.input.md) | (payload: Payload) => void | | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementclasses.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementclasses.md deleted file mode 100644 index 1a14e2505..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementclasses.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [elementClasses](./node-tracker.formfocusorchangeevent.elementclasses.md) - -## FormFocusOrChangeEvent.elementClasses property - -The class names on the element - -Signature: - -```typescript -elementClasses?: Array | null; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementid.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementid.md deleted file mode 100644 index 17e6a12c2..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.elementid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [elementId](./node-tracker.formfocusorchangeevent.elementid.md) - -## FormFocusOrChangeEvent.elementId property - -The element ID which the user is interacting with - -Signature: - -```typescript -elementId: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.formid.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.formid.md deleted file mode 100644 index bd2f9d9b3..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.formid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [formId](./node-tracker.formfocusorchangeevent.formid.md) - -## FormFocusOrChangeEvent.formId property - -The ID of the form which the element belongs to - -Signature: - -```typescript -formId: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.md deleted file mode 100644 index af684f575..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) - -## FormFocusOrChangeEvent interface - -Represents either a Form Focus or Form Change event When a user focuses on a form element or when a user makes a change to a form element. - -Signature: - -```typescript -interface FormFocusOrChangeEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elementClasses?](./node-tracker.formfocusorchangeevent.elementclasses.md) | Array<string> \| null | (Optional) The class names on the element | -| [elementId](./node-tracker.formfocusorchangeevent.elementid.md) | string | The element ID which the user is interacting with | -| [formId](./node-tracker.formfocusorchangeevent.formid.md) | string | The ID of the form which the element belongs to | -| [nodeName](./node-tracker.formfocusorchangeevent.nodename.md) | string | The name of the node ("INPUT", "TEXTAREA", "SELECT") | -| [schema](./node-tracker.formfocusorchangeevent.schema.md) | "change\_form" \| "focus\_form" | The schema which will be used for the event | -| [type?](./node-tracker.formfocusorchangeevent.type.md) | string \| null | (Optional) The type of element (e.g. "datetime", "text", "radio", etc.) | -| [value](./node-tracker.formfocusorchangeevent.value.md) | string \| null | The value of the element at the time of the event firing | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.nodename.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.nodename.md deleted file mode 100644 index 74a541da3..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.nodename.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [nodeName](./node-tracker.formfocusorchangeevent.nodename.md) - -## FormFocusOrChangeEvent.nodeName property - -The name of the node ("INPUT", "TEXTAREA", "SELECT") - -Signature: - -```typescript -nodeName: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.schema.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.schema.md deleted file mode 100644 index 247eb8ead..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.schema.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [schema](./node-tracker.formfocusorchangeevent.schema.md) - -## FormFocusOrChangeEvent.schema property - -The schema which will be used for the event - -Signature: - -```typescript -schema: "change_form" | "focus_form"; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.type.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.type.md deleted file mode 100644 index cc6feca41..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [type](./node-tracker.formfocusorchangeevent.type.md) - -## FormFocusOrChangeEvent.type property - -The type of element (e.g. "datetime", "text", "radio", etc.) - -Signature: - -```typescript -type?: string | null; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.value.md b/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.value.md deleted file mode 100644 index a7f34f175..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formfocusorchangeevent.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) > [value](./node-tracker.formfocusorchangeevent.value.md) - -## FormFocusOrChangeEvent.value property - -The value of the element at the time of the event firing - -Signature: - -```typescript -value: string | null; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.elements.md b/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.elements.md deleted file mode 100644 index b8b5badaf..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.elements.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) > [elements](./node-tracker.formsubmissionevent.elements.md) - -## FormSubmissionEvent.elements property - -The elements contained within the form - -Signature: - -```typescript -elements?: Array; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formclasses.md b/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formclasses.md deleted file mode 100644 index 52bc3040a..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formclasses.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) > [formClasses](./node-tracker.formsubmissionevent.formclasses.md) - -## FormSubmissionEvent.formClasses property - -The class names on the form - -Signature: - -```typescript -formClasses?: Array; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formid.md b/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formid.md deleted file mode 100644 index c87c64433..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.formid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) > [formId](./node-tracker.formsubmissionevent.formid.md) - -## FormSubmissionEvent.formId property - -The ID of the form - -Signature: - -```typescript -formId: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.md deleted file mode 100644 index 10a9b5f82..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.formsubmissionevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) - -## FormSubmissionEvent interface - -A Form Submission Event Used to track when a user submits a form - -Signature: - -```typescript -interface FormSubmissionEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elements?](./node-tracker.formsubmissionevent.elements.md) | Array<FormElement> | (Optional) The elements contained within the form | -| [formClasses?](./node-tracker.formsubmissionevent.formclasses.md) | Array<string> | (Optional) The class names on the form | -| [formId](./node-tracker.formsubmissionevent.formid.md) | string | The ID of the form | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md b/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md deleted file mode 100644 index 36aa918c6..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [gotEmitter](./node-tracker.gotemitter.md) - -## gotEmitter() function - -Create an emitter object, which uses the `got` library, that will send events to a collector - -Signature: - -```typescript -declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response) => void, agents?: Agents): Emitter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| endpoint | string | The collector to which events will be sent | -| protocol | HttpProtocol | http or https | -| port | number | The port for requests to use | -| method | HttpMethod | get or post | -| bufferSize | number | Number of events which can be queued before flush is called | -| retry | number \| Partial<RequiredRetryOptions> | Configure the retry policy for got - https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#retry | -| cookieJar | PromiseCookieJar \| ToughCookieJar | Add a cookieJar to got - https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#cookiejar | -| callback | (error?: RequestError, response?: Response<string>) => void | Callback called after a got request following retries - called with ErrorRequest (https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#errors) and Response (https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#response) | -| agents | Agents | Set new http.Agent and https.Agent objects on got requests - https://github.com/sindresorhus/got/blob/v11.5.2/readme.md\#agent | - -Returns: - -Emitter - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.httpmethod.md b/trackers/node-tracker/docs/markdown/node-tracker.httpmethod.md deleted file mode 100644 index bb8a91f6b..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.httpmethod.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [HttpMethod](./node-tracker.httpmethod.md) - -## HttpMethod enum - -Signature: - -```typescript -declare enum HttpMethod -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| GET | "get" | | -| POST | "post" | | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.httpprotocol.md b/trackers/node-tracker/docs/markdown/node-tracker.httpprotocol.md deleted file mode 100644 index c03c42c99..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.httpprotocol.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [HttpProtocol](./node-tracker.httpprotocol.md) - -## HttpProtocol enum - -Signature: - -```typescript -declare enum HttpProtocol -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| HTTP | "http" | | -| HTTPS | "https" | | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementclasses.md b/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementclasses.md deleted file mode 100644 index 1e6e5c891..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementclasses.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementClasses](./node-tracker.linkclickevent.elementclasses.md) - -## LinkClickEvent.elementClasses property - -An array of class names from the element clicked - -Signature: - -```typescript -elementClasses?: Array; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementcontent.md b/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementcontent.md deleted file mode 100644 index 3612c2946..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementcontent.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementContent](./node-tracker.linkclickevent.elementcontent.md) - -## LinkClickEvent.elementContent property - -The content of the element if present and enabled - -Signature: - -```typescript -elementContent?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementid.md b/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementid.md deleted file mode 100644 index b755d563e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementId](./node-tracker.linkclickevent.elementid.md) - -## LinkClickEvent.elementId property - -The ID of the element clicked if present - -Signature: - -```typescript -elementId?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementtarget.md b/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementtarget.md deleted file mode 100644 index 8a3f1e7be..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.elementtarget.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [elementTarget](./node-tracker.linkclickevent.elementtarget.md) - -## LinkClickEvent.elementTarget property - -The target value of the element if present - -Signature: - -```typescript -elementTarget?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.md b/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.md deleted file mode 100644 index 07a6312e0..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) - -## LinkClickEvent interface - -A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag - -Signature: - -```typescript -interface LinkClickEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [elementClasses?](./node-tracker.linkclickevent.elementclasses.md) | Array<string> | (Optional) An array of class names from the element clicked | -| [elementContent?](./node-tracker.linkclickevent.elementcontent.md) | string | (Optional) The content of the element if present and enabled | -| [elementId?](./node-tracker.linkclickevent.elementid.md) | string | (Optional) The ID of the element clicked if present | -| [elementTarget?](./node-tracker.linkclickevent.elementtarget.md) | string | (Optional) The target value of the element if present | -| [targetUrl](./node-tracker.linkclickevent.targeturl.md) | string | The target URL of the link | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.targeturl.md b/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.targeturl.md deleted file mode 100644 index f31b90e57..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.linkclickevent.targeturl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [LinkClickEvent](./node-tracker.linkclickevent.md) > [targetUrl](./node-tracker.linkclickevent.targeturl.md) - -## LinkClickEvent.targetUrl property - -The target URL of the link - -Signature: - -```typescript -targetUrl: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.md b/trackers/node-tracker/docs/markdown/node-tracker.md deleted file mode 100644 index 82ddbc525..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.md +++ /dev/null @@ -1,85 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) - -## node-tracker package - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [HttpMethod](./node-tracker.httpmethod.md) | | -| [HttpProtocol](./node-tracker.httpprotocol.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [buildAdClick(event)](./node-tracker.buildadclick.md) | Build a Ad Click Event Used to track an advertisement click | -| [buildAdConversion(event)](./node-tracker.buildadconversion.md) | Build a Ad Conversion Event Used to track an advertisement click | -| [buildAddToCart(event)](./node-tracker.buildaddtocart.md) | Build a Add To Cart Event For tracking users adding items from a cart on an ecommerce site. | -| [buildAdImpression(event)](./node-tracker.buildadimpression.md) | Build a Ad Impression Event Used to track an advertisement impression | -| [buildConsentGranted(event)](./node-tracker.buildconsentgranted.md) | Build a Consent Granted Event Used for tracking when a user grants their consent | -| [buildConsentWithdrawn(event)](./node-tracker.buildconsentwithdrawn.md) | Build a Consent Withdrawn Event Used for tracking when a user withdraws their consent | -| [buildEcommerceTransaction(event)](./node-tracker.buildecommercetransaction.md) | Build an Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a consumer completes a transaction. | -| [buildEcommerceTransactionItem(event)](./node-tracker.buildecommercetransactionitem.md) | Build an Ecommerce Transaction Item Event Related to the [buildEcommerceTransaction()](./node-tracker.buildecommercetransaction.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events | -| [buildFormFocusOrChange(event)](./node-tracker.buildformfocusorchange.md) | Build a Form Focus or Change Form Event based on schema property When a user focuses on a form element or when a user makes a change to a form element. | -| [buildFormSubmission(event)](./node-tracker.buildformsubmission.md) | Build a Form Submission Event Used to track when a user submits a form | -| [buildLinkClick(event)](./node-tracker.buildlinkclick.md) | Build a Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag | -| [buildPagePing(event)](./node-tracker.buildpageping.md) | Build a Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view | -| [buildPageView(event)](./node-tracker.buildpageview.md) | Build a Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA). | -| [buildRemoveFromCart(event)](./node-tracker.buildremovefromcart.md) | Build a Remove From Cart Event For tracking users removing items from a cart on an ecommerce site. | -| [buildScreenView(event)](./node-tracker.buildscreenview.md) | Build a Scren View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events | -| [buildSelfDescribingEvent(event)](./node-tracker.buildselfdescribingevent.md) | Build a self-describing event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema | -| [buildSiteSearch(event)](./node-tracker.buildsitesearch.md) | Build a Site Search Event Used when a user performs a search action on a page | -| [buildSocialInteraction(event)](./node-tracker.buildsocialinteraction.md) | Build a Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. | -| [buildStructEvent(event)](./node-tracker.buildstructevent.md) | Build a Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. | -| [gotEmitter(endpoint, protocol, port, method, bufferSize, retry, cookieJar, callback, agents)](./node-tracker.gotemitter.md) | Create an emitter object, which uses the got library, that will send events to a collector | -| [tracker(emitters, namespace, appId, encodeBase64)](./node-tracker.tracker.md) | Snowplow Node.js Tracker | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AdClickEvent](./node-tracker.adclickevent.md) | An Ad Click Event Used to track an advertisement click | -| [AdConversionEvent](./node-tracker.adconversionevent.md) | An Ad Conversion Event Used to track an advertisement click | -| [AddToCartEvent](./node-tracker.addtocartevent.md) | An Add To Cart Event For tracking users adding items from a cart on an ecommerce site. | -| [AdImpressionEvent](./node-tracker.adimpressionevent.md) | An Ad Impression Event Used to track an advertisement impression | -| [ConsentGrantedEvent](./node-tracker.consentgrantedevent.md) | A Consent Granted Event Used for tracking when a user grants their consent | -| [ConsentWithdrawnEvent](./node-tracker.consentwithdrawnevent.md) | A Consent Withdrawn Event Used for tracking when a user withdraws their consent | -| [ContextEvent](./node-tracker.contextevent.md) | Argument for [ContextGenerator](./node-tracker.contextgenerator.md) and [ContextFilter](./node-tracker.contextfilter.md) callback | -| [CoreConfiguration](./node-tracker.coreconfiguration.md) | The configuration object for the tracker core library | -| [CorePlugin](./node-tracker.coreplugin.md) | Interface which defines Core Plugins | -| [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) | An Ecommerce Transaction Event Allows for tracking common ecommerce events, this event is usually used when a customer completes a transaction. | -| [EcommerceTransactionItemEvent](./node-tracker.ecommercetransactionitemevent.md) | An Ecommerce Transaction Item Related to the [EcommerceTransactionEvent](./node-tracker.ecommercetransactionevent.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events | -| [Emitter](./node-tracker.emitter.md) | | -| [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) | Represents either a Form Focus or Form Change event When a user focuses on a form element or when a user makes a change to a form element. | -| [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) | A Form Submission Event Used to track when a user submits a form | -| [LinkClickEvent](./node-tracker.linkclickevent.md) | A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag | -| [PagePingEvent](./node-tracker.pagepingevent.md) | A Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view | -| [PageViewEvent](./node-tracker.pageviewevent.md) | A Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA). | -| [PayloadBuilder](./node-tracker.payloadbuilder.md) | Interface for mutable object encapsulating tracker payload | -| [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) | An Remove To Cart Event For tracking users removing items from a cart on an ecommerce site. | -| [ScreenViewEvent](./node-tracker.screenviewevent.md) | A Screen View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events | -| [SelfDescribingEvent](./node-tracker.selfdescribingevent.md) | A Self Describing Event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema | -| [SiteSearchEvent](./node-tracker.sitesearchevent.md) | A Site Search Event Used when a user performs a search action on a page | -| [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) | A Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. | -| [StructuredEvent](./node-tracker.structuredevent.md) | A Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. | -| [Tracker](./node-tracker.tracker.md) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [version](./node-tracker.version.md) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [ContextFilter](./node-tracker.contextfilter.md) | A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event | -| [ContextGenerator](./node-tracker.contextgenerator.md) | A context generator is a user-supplied callback that is evaluated for each event to allow an additional context to be dynamically attached to the event | -| [Payload](./node-tracker.payload.md) | Type for a Payload dictionary | -| [SelfDescribingJson](./node-tracker.selfdescribingjson.md) | export interface for any Self-Describing JSON such as context or Self Describing events | -| [Timestamp](./node-tracker.timestamp.md) | Algebraic datatype representing possible timestamp type choice | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxxoffset.md b/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxxoffset.md deleted file mode 100644 index d34b5f1ed..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxxoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [maxXOffset](./node-tracker.pagepingevent.maxxoffset.md) - -## PagePingEvent.maxXOffset property - -The maximum X scroll position for the current page view - -Signature: - -```typescript -maxXOffset?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxyoffset.md b/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxyoffset.md deleted file mode 100644 index 06ccfd1fa..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.maxyoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [maxYOffset](./node-tracker.pagepingevent.maxyoffset.md) - -## PagePingEvent.maxYOffset property - -The maximum Y scroll position for the current page view - -Signature: - -```typescript -maxYOffset?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.md b/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.md deleted file mode 100644 index 70195df4e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) - -## PagePingEvent interface - -A Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view - -Signature: - -```typescript -interface PagePingEvent extends PageViewEvent -``` -Extends: PageViewEvent - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [maxXOffset?](./node-tracker.pagepingevent.maxxoffset.md) | number | (Optional) The maximum X scroll position for the current page view | -| [maxYOffset?](./node-tracker.pagepingevent.maxyoffset.md) | number | (Optional) The maximum Y scroll position for the current page view | -| [minXOffset?](./node-tracker.pagepingevent.minxoffset.md) | number | (Optional) The minimum X scroll position for the current page view | -| [minYOffset?](./node-tracker.pagepingevent.minyoffset.md) | number | (Optional) The minimum Y scroll position for the current page view | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minxoffset.md b/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minxoffset.md deleted file mode 100644 index 5b54313d6..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minxoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [minXOffset](./node-tracker.pagepingevent.minxoffset.md) - -## PagePingEvent.minXOffset property - -The minimum X scroll position for the current page view - -Signature: - -```typescript -minXOffset?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minyoffset.md b/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minyoffset.md deleted file mode 100644 index ea3e5a487..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pagepingevent.minyoffset.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PagePingEvent](./node-tracker.pagepingevent.md) > [minYOffset](./node-tracker.pagepingevent.minyoffset.md) - -## PagePingEvent.minYOffset property - -The minimum Y scroll position for the current page view - -Signature: - -```typescript -minYOffset?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.md deleted file mode 100644 index 68379fae6..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) - -## PageViewEvent interface - -A Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA). - -Signature: - -```typescript -interface PageViewEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [pageTitle?](./node-tracker.pageviewevent.pagetitle.md) | string \| null | (Optional) The current page title in the users browser | -| [pageUrl?](./node-tracker.pageviewevent.pageurl.md) | string \| null | (Optional) The current URL visible in the users browser | -| [referrer?](./node-tracker.pageviewevent.referrer.md) | string \| null | (Optional) The URL of the referring page | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pagetitle.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pagetitle.md deleted file mode 100644 index 45d440241..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pagetitle.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) > [pageTitle](./node-tracker.pageviewevent.pagetitle.md) - -## PageViewEvent.pageTitle property - -The current page title in the users browser - -Signature: - -```typescript -pageTitle?: string | null; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pageurl.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pageurl.md deleted file mode 100644 index dff6ff16f..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.pageurl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) > [pageUrl](./node-tracker.pageviewevent.pageurl.md) - -## PageViewEvent.pageUrl property - -The current URL visible in the users browser - -Signature: - -```typescript -pageUrl?: string | null; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.referrer.md b/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.referrer.md deleted file mode 100644 index 510d0ba44..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.pageviewevent.referrer.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PageViewEvent](./node-tracker.pageviewevent.md) > [referrer](./node-tracker.pageviewevent.referrer.md) - -## PageViewEvent.referrer property - -The URL of the referring page - -Signature: - -```typescript -referrer?: string | null; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payload.md b/trackers/node-tracker/docs/markdown/node-tracker.payload.md deleted file mode 100644 index 69b929d26..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Payload](./node-tracker.payload.md) - -## Payload type - -Type for a Payload dictionary - -Signature: - -```typescript -type Payload = Record; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.add.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.add.md deleted file mode 100644 index 979815d0b..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.add.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [add](./node-tracker.payloadbuilder.add.md) - -## PayloadBuilder.add property - -Adds an entry to the Payload - -Signature: - -```typescript -add: (key: string, value: unknown) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md deleted file mode 100644 index 84929af64..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) - -## PayloadBuilder.addContextEntity property - -Caches a context entity to be added to payload on build - -Signature: - -```typescript -addContextEntity: (entity: SelfDescribingJson) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.adddict.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.adddict.md deleted file mode 100644 index a4fa7da8a..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.adddict.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addDict](./node-tracker.payloadbuilder.adddict.md) - -## PayloadBuilder.addDict property - -Merges a payload into the existing payload - -Signature: - -```typescript -addDict: (dict: Payload) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addjson.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addjson.md deleted file mode 100644 index 0e572fb3c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addjson.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addJson](./node-tracker.payloadbuilder.addjson.md) - -## PayloadBuilder.addJson property - -Caches a JSON object to be added to payload on build - -Signature: - -```typescript -addJson: (keyIfEncoded: string, keyIfNotEncoded: string, json: Record) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.build.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.build.md deleted file mode 100644 index da0bc05e3..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.build.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [build](./node-tracker.payloadbuilder.build.md) - -## PayloadBuilder.build property - -Builds and returns the Payload - -Signature: - -```typescript -build: () => Payload; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getjson.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getjson.md deleted file mode 100644 index 515efac39..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getjson.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [getJson](./node-tracker.payloadbuilder.getjson.md) - -## PayloadBuilder.getJson property - -Gets all JSON objects added to payload - -Signature: - -```typescript -getJson: () => EventJson; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getpayload.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getpayload.md deleted file mode 100644 index 0c704fd6b..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.getpayload.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [getPayload](./node-tracker.payloadbuilder.getpayload.md) - -## PayloadBuilder.getPayload property - -Gets the current payload, before cached JSON is processed - -Signature: - -```typescript -getPayload: () => Payload; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md deleted file mode 100644 index ecda8875f..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) - -## PayloadBuilder interface - -Interface for mutable object encapsulating tracker payload - -Signature: - -```typescript -interface PayloadBuilder -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [add](./node-tracker.payloadbuilder.add.md) | (key: string, value: unknown) => void | Adds an entry to the Payload | -| [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) | (entity: SelfDescribingJson) => void | Caches a context entity to be added to payload on build | -| [addDict](./node-tracker.payloadbuilder.adddict.md) | (dict: Payload) => void | Merges a payload into the existing payload | -| [addJson](./node-tracker.payloadbuilder.addjson.md) | (keyIfEncoded: string, keyIfNotEncoded: string, json: Record<string, unknown>) => void | Caches a JSON object to be added to payload on build | -| [build](./node-tracker.payloadbuilder.build.md) | () => Payload | Builds and returns the Payload | -| [getJson](./node-tracker.payloadbuilder.getjson.md) | () => EventJson | Gets all JSON objects added to payload | -| [getPayload](./node-tracker.payloadbuilder.getpayload.md) | () => Payload | Gets the current payload, before cached JSON is processed | -| [withJsonProcessor](./node-tracker.payloadbuilder.withjsonprocessor.md) | (jsonProcessor: JsonProcessor) => void | Adds a function which will be executed when building the payload to process the JSON which has been added to this payload | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.withjsonprocessor.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.withjsonprocessor.md deleted file mode 100644 index 993c4d7af..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.withjsonprocessor.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [withJsonProcessor](./node-tracker.payloadbuilder.withjsonprocessor.md) - -## PayloadBuilder.withJsonProcessor property - -Adds a function which will be executed when building the payload to process the JSON which has been added to this payload - -Signature: - -```typescript -withJsonProcessor: (jsonProcessor: JsonProcessor) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.category.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.category.md deleted file mode 100644 index 78fd85461..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.category.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [category](./node-tracker.removefromcartevent.category.md) - -## RemoveFromCartEvent.category property - -The category of the product - -Signature: - -```typescript -category?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.currency.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.currency.md deleted file mode 100644 index 49749c5dc..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.currency.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [currency](./node-tracker.removefromcartevent.currency.md) - -## RemoveFromCartEvent.currency property - -The currency of the product - -Signature: - -```typescript -currency?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.md deleted file mode 100644 index 2ce7163be..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) - -## RemoveFromCartEvent interface - -An Remove To Cart Event For tracking users removing items from a cart on an ecommerce site. - -Signature: - -```typescript -interface RemoveFromCartEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [category?](./node-tracker.removefromcartevent.category.md) | string | (Optional) The category of the product | -| [currency?](./node-tracker.removefromcartevent.currency.md) | string | (Optional) The currency of the product | -| [name?](./node-tracker.removefromcartevent.name.md) | string | (Optional) The name of the product | -| [quantity](./node-tracker.removefromcartevent.quantity.md) | number | The number removed from the cart | -| [sku](./node-tracker.removefromcartevent.sku.md) | string | A Product Stock Keeping Unit (SKU) | -| [unitPrice?](./node-tracker.removefromcartevent.unitprice.md) | number | (Optional) The price of the product | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.name.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.name.md deleted file mode 100644 index f7fb450b1..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [name](./node-tracker.removefromcartevent.name.md) - -## RemoveFromCartEvent.name property - -The name of the product - -Signature: - -```typescript -name?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.quantity.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.quantity.md deleted file mode 100644 index 718048c88..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.quantity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [quantity](./node-tracker.removefromcartevent.quantity.md) - -## RemoveFromCartEvent.quantity property - -The number removed from the cart - -Signature: - -```typescript -quantity: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.sku.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.sku.md deleted file mode 100644 index f8314446e..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.sku.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [sku](./node-tracker.removefromcartevent.sku.md) - -## RemoveFromCartEvent.sku property - -A Product Stock Keeping Unit (SKU) - -Signature: - -```typescript -sku: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.unitprice.md b/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.unitprice.md deleted file mode 100644 index db5c2bf06..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.removefromcartevent.unitprice.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [RemoveFromCartEvent](./node-tracker.removefromcartevent.md) > [unitPrice](./node-tracker.removefromcartevent.unitprice.md) - -## RemoveFromCartEvent.unitPrice property - -The price of the product - -Signature: - -```typescript -unitPrice?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.id.md b/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.id.md deleted file mode 100644 index 5d48b9793..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ScreenViewEvent](./node-tracker.screenviewevent.md) > [id](./node-tracker.screenviewevent.id.md) - -## ScreenViewEvent.id property - -The identifier of the screen - -Signature: - -```typescript -id?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.md b/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.md deleted file mode 100644 index 7ae8e119f..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ScreenViewEvent](./node-tracker.screenviewevent.md) - -## ScreenViewEvent interface - -A Screen View Event Similar to a Page View but less focused on typical web properties Often used for mobile applications as the user is presented with new views as they performance navigation events - -Signature: - -```typescript -interface ScreenViewEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [id?](./node-tracker.screenviewevent.id.md) | string | (Optional) The identifier of the screen | -| [name?](./node-tracker.screenviewevent.name.md) | string | (Optional) The name of the screen | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.name.md b/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.name.md deleted file mode 100644 index 698ad7b77..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.screenviewevent.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [ScreenViewEvent](./node-tracker.screenviewevent.md) > [name](./node-tracker.screenviewevent.name.md) - -## ScreenViewEvent.name property - -The name of the screen - -Signature: - -```typescript -name?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.event.md b/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.event.md deleted file mode 100644 index cf7c8fc0c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.event.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SelfDescribingEvent](./node-tracker.selfdescribingevent.md) > [event](./node-tracker.selfdescribingevent.event.md) - -## SelfDescribingEvent.event property - -The Self Describing JSON which describes the event - -Signature: - -```typescript -event: SelfDescribingJson; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.md b/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.md deleted file mode 100644 index 841e9e3c0..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingevent.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SelfDescribingEvent](./node-tracker.selfdescribingevent.md) - -## SelfDescribingEvent interface - -A Self Describing Event A custom event type, allowing for an event to be tracked using your own custom schema and a data object which conforms to the supplied schema - -Signature: - -```typescript -interface SelfDescribingEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [event](./node-tracker.selfdescribingevent.event.md) | SelfDescribingJson | The Self Describing JSON which describes the event | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingjson.md b/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingjson.md deleted file mode 100644 index a107c6c06..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.selfdescribingjson.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SelfDescribingJson](./node-tracker.selfdescribingjson.md) - -## SelfDescribingJson type - -export interface for any Self-Describing JSON such as context or Self Describing events - -Signature: - -```typescript -type SelfDescribingJson = Record> = { - schema: string; - data: T; -}; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.filters.md b/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.filters.md deleted file mode 100644 index e963f101d..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.filters.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [filters](./node-tracker.sitesearchevent.filters.md) - -## SiteSearchEvent.filters property - -Any filters which have been applied to the search - -Signature: - -```typescript -filters?: Record; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.md b/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.md deleted file mode 100644 index b412bbd27..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) - -## SiteSearchEvent interface - -A Site Search Event Used when a user performs a search action on a page - -Signature: - -```typescript -interface SiteSearchEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [filters?](./node-tracker.sitesearchevent.filters.md) | Record<string, string \| boolean> | (Optional) Any filters which have been applied to the search | -| [pageResults?](./node-tracker.sitesearchevent.pageresults.md) | number | (Optional) The number of visible results on the page | -| [terms](./node-tracker.sitesearchevent.terms.md) | Array<string> | The terms of the search | -| [totalResults?](./node-tracker.sitesearchevent.totalresults.md) | number | (Optional) The total number of results for this search | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.pageresults.md b/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.pageresults.md deleted file mode 100644 index a30c5d6ed..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.pageresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [pageResults](./node-tracker.sitesearchevent.pageresults.md) - -## SiteSearchEvent.pageResults property - -The number of visible results on the page - -Signature: - -```typescript -pageResults?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.terms.md b/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.terms.md deleted file mode 100644 index 6f4a45ceb..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.terms.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [terms](./node-tracker.sitesearchevent.terms.md) - -## SiteSearchEvent.terms property - -The terms of the search - -Signature: - -```typescript -terms: Array; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.totalresults.md b/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.totalresults.md deleted file mode 100644 index 7b79bd694..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.sitesearchevent.totalresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SiteSearchEvent](./node-tracker.sitesearchevent.md) > [totalResults](./node-tracker.sitesearchevent.totalresults.md) - -## SiteSearchEvent.totalResults property - -The total number of results for this search - -Signature: - -```typescript -totalResults?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.action.md b/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.action.md deleted file mode 100644 index b0f8c0975..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.action.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) > [action](./node-tracker.socialinteractionevent.action.md) - -## SocialInteractionEvent.action property - -Social action performed - -Signature: - -```typescript -action: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.md b/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.md deleted file mode 100644 index b079030fa..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) - -## SocialInteractionEvent interface - -A Social Interaction Event Social tracking will be used to track the way users interact with Facebook, Twitter and Google + widgets e.g. to capture “like this” or “tweet this” events. - -Signature: - -```typescript -interface SocialInteractionEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action](./node-tracker.socialinteractionevent.action.md) | string | Social action performed | -| [network](./node-tracker.socialinteractionevent.network.md) | string | Social network | -| [target?](./node-tracker.socialinteractionevent.target.md) | string | (Optional) Object social action is performed on | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.network.md b/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.network.md deleted file mode 100644 index a5301b629..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.network.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) > [network](./node-tracker.socialinteractionevent.network.md) - -## SocialInteractionEvent.network property - -Social network - -Signature: - -```typescript -network: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.target.md b/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.target.md deleted file mode 100644 index a809bc4bb..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.socialinteractionevent.target.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [SocialInteractionEvent](./node-tracker.socialinteractionevent.md) > [target](./node-tracker.socialinteractionevent.target.md) - -## SocialInteractionEvent.target property - -Object social action is performed on - -Signature: - -```typescript -target?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.action.md b/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.action.md deleted file mode 100644 index 7ecfbb207..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.action.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [action](./node-tracker.structuredevent.action.md) - -## StructuredEvent.action property - -Signature: - -```typescript -action: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.category.md b/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.category.md deleted file mode 100644 index 663b2514c..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.category.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [category](./node-tracker.structuredevent.category.md) - -## StructuredEvent.category property - -Signature: - -```typescript -category: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.label.md b/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.label.md deleted file mode 100644 index c92653178..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.label.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [label](./node-tracker.structuredevent.label.md) - -## StructuredEvent.label property - -Signature: - -```typescript -label?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.md b/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.md deleted file mode 100644 index f42afa8ac..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) - -## StructuredEvent interface - -A Structured Event A classic style of event tracking, allows for easier movement between analytics systems. A loosely typed event, creating a Self Describing event is preferred, but useful for interoperability. - -Signature: - -```typescript -interface StructuredEvent -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [action](./node-tracker.structuredevent.action.md) | string | | -| [category](./node-tracker.structuredevent.category.md) | string | | -| [label?](./node-tracker.structuredevent.label.md) | string | (Optional) | -| [property?](./node-tracker.structuredevent.property.md) | string | (Optional) | -| [value?](./node-tracker.structuredevent.value.md) | number | (Optional) | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.property.md b/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.property.md deleted file mode 100644 index 3cf1a6ba1..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.property.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [property](./node-tracker.structuredevent.property.md) - -## StructuredEvent.property property - -Signature: - -```typescript -property?: string; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.value.md b/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.value.md deleted file mode 100644 index e1d1d056d..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.structuredevent.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [StructuredEvent](./node-tracker.structuredevent.md) > [value](./node-tracker.structuredevent.value.md) - -## StructuredEvent.value property - -Signature: - -```typescript -value?: number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.timestamp.md b/trackers/node-tracker/docs/markdown/node-tracker.timestamp.md deleted file mode 100644 index 0092ffdc2..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.timestamp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Timestamp](./node-tracker.timestamp.md) - -## Timestamp type - -Algebraic datatype representing possible timestamp type choice - -Signature: - -```typescript -type Timestamp = TrueTimestamp | DeviceTimestamp | number; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.tracker.md b/trackers/node-tracker/docs/markdown/node-tracker.tracker.md deleted file mode 100644 index 8974598de..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.tracker.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) - -## Tracker interface - -Signature: - -```typescript -interface Tracker extends TrackerCore -``` -Extends: TrackerCore - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [setDomainUserId](./node-tracker.tracker.setdomainuserid.md) | (userId: string) => void | Set the domain user ID | -| [setNetworkUserId](./node-tracker.tracker.setnetworkuserid.md) | (userId: string) => void | Set the network user ID | -| [setSessionId](./node-tracker.tracker.setsessionid.md) | (sessionId: string) => void | Set the session ID (domain_sessionid in the atomic events) | -| [setSessionIndex](./node-tracker.tracker.setsessionindex.md) | (sessionIndex: string \| number) => void | Set the session index (domain_sessionidx in the atomic events) | - diff --git a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setdomainuserid.md b/trackers/node-tracker/docs/markdown/node-tracker.tracker.setdomainuserid.md deleted file mode 100644 index afa5bbeca..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setdomainuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setDomainUserId](./node-tracker.tracker.setdomainuserid.md) - -## Tracker.setDomainUserId property - -Set the domain user ID - -Signature: - -```typescript -setDomainUserId: (userId: string) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setnetworkuserid.md b/trackers/node-tracker/docs/markdown/node-tracker.tracker.setnetworkuserid.md deleted file mode 100644 index ae7ff4348..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setnetworkuserid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setNetworkUserId](./node-tracker.tracker.setnetworkuserid.md) - -## Tracker.setNetworkUserId property - -Set the network user ID - -Signature: - -```typescript -setNetworkUserId: (userId: string) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionid.md b/trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionid.md deleted file mode 100644 index 24cc52945..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setSessionId](./node-tracker.tracker.setsessionid.md) - -## Tracker.setSessionId property - -Set the session ID (`domain_sessionid` in the atomic events) - -Signature: - -```typescript -setSessionId: (sessionId: string) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionindex.md b/trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionindex.md deleted file mode 100644 index 0432007c2..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.tracker.setsessionindex.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [Tracker](./node-tracker.tracker.md) > [setSessionIndex](./node-tracker.tracker.setsessionindex.md) - -## Tracker.setSessionIndex property - -Set the session index (`domain_sessionidx` in the atomic events) - -Signature: - -```typescript -setSessionIndex: (sessionIndex: string | number) => void; -``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.version.md b/trackers/node-tracker/docs/markdown/node-tracker.version.md deleted file mode 100644 index 6d17a1434..000000000 --- a/trackers/node-tracker/docs/markdown/node-tracker.version.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [version](./node-tracker.version.md) - -## version variable - -Signature: - -```typescript -version: string -``` diff --git a/trackers/node-tracker/docs/node-tracker.api.md b/trackers/node-tracker/docs/node-tracker.api.md deleted file mode 100644 index 081f51e82..000000000 --- a/trackers/node-tracker/docs/node-tracker.api.md +++ /dev/null @@ -1,375 +0,0 @@ -## API Report File for "@snowplow/node-tracker" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { Agents } from 'got'; -import { PromiseCookieJar } from 'got'; -import { RequestError } from 'got'; -import { RequiredRetryOptions } from 'got'; -import { Response } from 'got'; -import { ToughCookieJar } from 'got'; - -// @public -export interface AdClickEvent { - advertiserId?: string; - bannerId?: string; - campaignId?: string; - clickId?: string; - cost?: number; - costModel?: "cpa" | "cpc" | "cpm"; - impressionId?: string; - targetUrl: string; - zoneId?: string; -} - -// @public -export interface AdConversionEvent { - action?: string; - advertiserId?: string; - campaignId?: string; - category?: string; - conversionId?: string; - cost?: number; - costModel?: "cpa" | "cpc" | "cpm"; - initialValue?: number; - property?: string; -} - -// @public -export interface AddToCartEvent { - category?: string; - currency?: string; - name?: string; - quantity: number; - sku: string; - unitPrice?: number; -} - -// @public -export interface AdImpressionEvent { - advertiserId?: string; - bannerId?: string; - campaignId?: string; - cost?: number; - costModel?: "cpa" | "cpc" | "cpm"; - impressionId?: string; - targetUrl?: string; - zoneId?: string; -} - -// @public -export function buildAdClick(event: AdClickEvent): PayloadBuilder; - -// @public -export function buildAdConversion(event: AdConversionEvent): PayloadBuilder; - -// @public -export function buildAddToCart(event: AddToCartEvent): PayloadBuilder; - -// @public -export function buildAdImpression(event: AdImpressionEvent): PayloadBuilder; - -// @public -export function buildConsentGranted(event: ConsentGrantedEvent): { - event: PayloadBuilder; - context: { - schema: string; - data: Record; - }[]; -}; - -// @public -export function buildConsentWithdrawn(event: ConsentWithdrawnEvent): { - event: PayloadBuilder; - context: { - schema: string; - data: Record; - }[]; -}; - -// @public -export function buildEcommerceTransaction(event: EcommerceTransactionEvent): PayloadBuilder; - -// @public -export function buildEcommerceTransactionItem(event: EcommerceTransactionItemEvent): PayloadBuilder; - -// @public -export function buildFormFocusOrChange(event: FormFocusOrChangeEvent): PayloadBuilder; - -// @public -export function buildFormSubmission(event: FormSubmissionEvent): PayloadBuilder; - -// @public -export function buildLinkClick(event: LinkClickEvent): PayloadBuilder; - -// @public -export function buildPagePing(event: PagePingEvent): PayloadBuilder; - -// @public -export function buildPageView(event: PageViewEvent): PayloadBuilder; - -// @public -export function buildRemoveFromCart(event: RemoveFromCartEvent): PayloadBuilder; - -// @public -export function buildScreenView(event: ScreenViewEvent): PayloadBuilder; - -// @public -export function buildSelfDescribingEvent(event: SelfDescribingEvent): PayloadBuilder; - -// @public -export function buildSiteSearch(event: SiteSearchEvent): PayloadBuilder; - -// @public -export function buildSocialInteraction(event: SocialInteractionEvent): PayloadBuilder; - -// @public -export function buildStructEvent(event: StructuredEvent): PayloadBuilder; - -// @public -export interface ConsentGrantedEvent { - description?: string; - expiry?: string; - id: string; - name?: string; - version: string; -} - -// @public -export interface ConsentWithdrawnEvent { - all: boolean; - description?: string; - id?: string; - name?: string; - version?: string; -} - -// @public -export interface ContextEvent { - event: Payload; - eventSchema: string; - eventType: string; -} - -// @public -export type ContextFilter = (args?: ContextEvent) => boolean; - -// @public -export type ContextGenerator = (args?: ContextEvent) => SelfDescribingJson | SelfDescribingJson[] | undefined; - -// @public -export interface CoreConfiguration { - /* Should payloads be base64 encoded when built */ - // (undocumented) - base64?: boolean; - /* A list of all the plugins to include at load */ - // (undocumented) - callback?: (PayloadData: PayloadBuilder) => void; - /* A list of all the plugins to include at load */ - // (undocumented) - corePlugins?: Array; -} - -// @public -export interface CorePlugin { - // Warning: (ae-forgotten-export) The symbol "TrackerCore" needs to be exported by the entry point index.module.d.ts - activateCorePlugin?: (core: TrackerCore) => void; - afterTrack?: (payload: Payload) => void; - beforeTrack?: (payloadBuilder: PayloadBuilder) => void; - contexts?: () => SelfDescribingJson[]; - // Warning: (ae-forgotten-export) The symbol "Logger" needs to be exported by the entry point index.module.d.ts - logger?: (logger: Logger) => void; -} - -// @public -export interface EcommerceTransactionEvent { - affiliation?: string; - city?: string; - country?: string; - currency?: string; - orderId: string; - shipping?: number; - state?: string; - tax?: number; - total: number; -} - -// @public -export interface EcommerceTransactionItemEvent { - category?: string; - currency?: string; - name?: string; - orderId: string; - price: number; - quantity?: number; - sku: string; -} - -// @public (undocumented) -export interface Emitter { - // (undocumented) - flush: () => void; - // (undocumented) - input: (payload: Payload) => void; -} - -// @public -export interface FormFocusOrChangeEvent { - elementClasses?: Array | null; - elementId: string; - formId: string; - nodeName: string; - schema: "change_form" | "focus_form"; - type?: string | null; - value: string | null; -} - -// @public -export interface FormSubmissionEvent { - // Warning: (ae-forgotten-export) The symbol "FormElement" needs to be exported by the entry point index.module.d.ts - elements?: Array; - formClasses?: Array; - formId: string; -} - -// @public -export function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response) => void, agents?: Agents): Emitter; - -// @public (undocumented) -export enum HttpMethod { - // (undocumented) - GET = "get", - // (undocumented) - POST = "post" -} - -// @public (undocumented) -export enum HttpProtocol { - // (undocumented) - HTTP = "http", - // (undocumented) - HTTPS = "https" -} - -// @public -export interface LinkClickEvent { - elementClasses?: Array; - elementContent?: string; - elementId?: string; - elementTarget?: string; - targetUrl: string; -} - -// @public -export interface PagePingEvent extends PageViewEvent { - maxXOffset?: number; - maxYOffset?: number; - minXOffset?: number; - minYOffset?: number; -} - -// @public -export interface PageViewEvent { - pageTitle?: string | null; - pageUrl?: string | null; - referrer?: string | null; -} - -// @public -export type Payload = Record; - -// @public -export interface PayloadBuilder { - add: (key: string, value: unknown) => void; - addContextEntity: (entity: SelfDescribingJson) => void; - addDict: (dict: Payload) => void; - addJson: (keyIfEncoded: string, keyIfNotEncoded: string, json: Record) => void; - build: () => Payload; - // Warning: (ae-forgotten-export) The symbol "EventJson" needs to be exported by the entry point index.module.d.ts - getJson: () => EventJson; - getPayload: () => Payload; - // Warning: (ae-forgotten-export) The symbol "JsonProcessor" needs to be exported by the entry point index.module.d.ts - withJsonProcessor: (jsonProcessor: JsonProcessor) => void; -} - -// @public -export interface RemoveFromCartEvent { - category?: string; - currency?: string; - name?: string; - quantity: number; - sku: string; - unitPrice?: number; -} - -// @public -export interface ScreenViewEvent { - id?: string; - name?: string; -} - -// @public -export interface SelfDescribingEvent { - event: SelfDescribingJson; -} - -// @public -export type SelfDescribingJson = Record> = { - schema: string; - data: T; -}; - -// @public -export interface SiteSearchEvent { - filters?: Record; - pageResults?: number; - terms: Array; - totalResults?: number; -} - -// @public -export interface SocialInteractionEvent { - action: string; - network: string; - target?: string; -} - -// @public -export interface StructuredEvent { - // (undocumented) - action: string; - // (undocumented) - category: string; - // (undocumented) - label?: string; - // (undocumented) - property?: string; - // (undocumented) - value?: number; -} - -// Warning: (ae-forgotten-export) The symbol "TrueTimestamp" needs to be exported by the entry point index.module.d.ts -// Warning: (ae-forgotten-export) The symbol "DeviceTimestamp" needs to be exported by the entry point index.module.d.ts -// -// @public -export type Timestamp = TrueTimestamp | DeviceTimestamp | number; - -// @public (undocumented) -export interface Tracker extends TrackerCore { - setDomainUserId: (userId: string) => void; - setNetworkUserId: (userId: string) => void; - setSessionId: (sessionId: string) => void; - setSessionIndex: (sessionIndex: string | number) => void; -} - -// @public -export function tracker(emitters: Emitter | Array, namespace: string, appId: string, encodeBase64: boolean): Tracker; - -// @public (undocumented) -export const version: string; - -// (No @packageDocumentation comment for this package) - -```