@keystonehq/sdk

@keystonehq/sdk

@keystonehq/sdk is library for helping developer to do integration with Keystone.

the main purpose is to encode and decode data for QR Code usage.

currently we use UR to encode data. check this for detail info about UR

Install

yarn add @keystonehq/sdk

npm install --save @keystonehq/sdk

Usage

import sdk from '@keystonehq/sdk';
const read = async () => {
    const result = await sdk.read();
}

const play = async () => {
    await sdk.play("any data string");
}

API

Name	Parameters	result	Description
read		Promise<{type: 'text' | 'json' | 'ur', data: string} | null>	Open a modal and read qrcode with camera, will return null when click Close button
play	data: string, options?: {refreshSpeed?: number}	Promise	Open a modal and display a dynamic qrcode, will resolve when click Finish button