oracular / RecordOptions
Interface: RecordOptions
Defined in: types.ts:395
What every record needs from the app, for createRecord and createEndRecord.
Example
ts
const recording: RecordOptions = { installId: storedInstallId, mode: 'shadow' };Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
installId | string | A random id the app generates once, on first use, and stores (for example crypto.randomUUID()). It groups one install's records across exports and nothing else; never derive it from the device, the account or anything else about the user. | types.ts:401 |
mode | RecordMode | Whether reveals are shown to the user right now. | types.ts:403 |
top? | number | How many signals to list in top, by size of impact. Default 3. | types.ts:405 |