Ketch TypeScript/JavaScript Module for Ketch Tag
npm install @ketch-sdk/ketch-jsKetch JavaScript ES Module for the Ketch Tag
``shell`
npm install --save @ketch-sdk/ketch-js
`typescript
import { loadScript } from '@ketch-sdk/ketch-js'
const api = await loadScript('myOrgCode', 'myPropertyCode')
`
`typescript`
api.registerPlugin(myPlugin)
`typescript`
api.registerIdentityProvider('myIdentity', myProvider)
`typescript`
api.registerStorageProvider(myProvider)
`typescript`
api.emit('myEvent', 'some argument')
`typescript
import { Consent } from '@ketch-sdk/ketch-types'
function myConsentHandler(consent: Consent) {
console.log(consent)
}
api.on('consent', myConsentHandler)
api.addListener('consent', myConsentHandler)
`
`typescript`
api.once('consent', myConsentHandler)
`typescript`
api.off('consent', myConsentHandler)
api.removeEventListener('consent', myConsentHandler)
`typescript`
api.removeAllListeners('consent')
`typescript`
const config = await api.getConfig()
`typescript`
const consent = await api.getConsent()
`typescript`
const env = await api.getEnvironment()
`typescript`
const ipInfo = await api.getGeoIP()
`typescript`
const identities = await api.getIdentities()
`typescript`
const jurisdiction = await api.getJurisdiction()
`typescript`
const regionInfo = await api.getRegionInfo()
`typescript`
api.showConsentExperience()
`typescript`
const options: ShowPreferenceOptions = {}
api.showPreferenceExperience(options)
`typescript``
const request: InvokeRightEvent = {}
api.invokeRight(request)