DocsAPI reference

License

Set the license key and read what it covers. The check runs in the browser and makes no network calls.

rowpine 1.0.3Generated from the package's type definitions

`setLicenseKey`

function

Set the license key. Call once, before the first export or pivot. Clears the cached status, so the next check verifies the new key and may log its notice again.

Signature

setLicenseKey(value: string | null | undefined) => void

Parameters

Name	Type	Description
`value`	`string \| null \| undefined`	The key, `RP1.<payload>.<signature>`. Whitespace around it is trimmed; null, undefined or '' removes the key.

Returns

void

`getLicenseStatus`

function

The current license status. The key is verified once and the result cached until setLicenseKey is called again. Logs nothing.

Signature

getLicenseStatus() => Promise<LicenseStatus>

Returns

Promise<LicenseStatus>

`LicenseStatus`

type

The result of checking the license key. buildDate is this build's date, YYYY-MM-DD. When licensed is false, reason says why: 'missing' (no key set), 'malformed' (not RP1.<payload>.<signature>, or the payload does not decode as JSON), 'invalid' (the signature does not verify, or v is not 1), or 'updates-ended' (this build is dated after the key's upd day; payload is included).

Type

type LicenseStatus = { licensed: true; payload: LicensePayload; buildDate: string; }
  | { licensed: false; reason: 'missing'
  | 'malformed'
  | 'invalid'
  | 'updates-ended'; payload?: LicensePayload; buildDate: string; }

`LicensePayload`

type

What a license key holds: the signed JSON payload between the two dots.

Properties

Name	Type	Description
`v`	`1`	Payload format version. A key with any other value is 'invalid'.
`sub`	`string`	Licensee name or company.
`plan`	`"developer" \| "team"`	The plan the key was issued for. Recorded in the key; the check does not read it.
`seats`	`number`	Number of seats. Recorded in the key; the check does not count them.
`upd`	`string`	Last day of the update period, YYYY-MM-DD.
`iat`	`string`	Issue date, YYYY-MM-DD.
`id`	`string`	Order or license id.

Was this page helpful?