import { GetParamsBase } from "../GetParamsBase"; export interface StatementParamsBase extends GetParamsBase { /** * Boolean determining if the statements’ attachments should be returned. Defaults to `false`. */ attachments?: boolean; /** * `format` – what human readable names and descriptions are included in the statements. * * - `exact` format returns the statements exactly as they were received by the LRS (with some possible exceptions). `exact` format should be used when moving statements between LRSs or other systems that store statements. * - `ids` format returns only ids are returned with none of the human readable descriptions. This is useful if you need to fetch data that will be used for aggregation or other processing where human language names and descriptions are not required. * - `canonical` format requests the LRS to return its own internal definitions of objects, rather than those provided in the statement. If you trust the LRS, this is normally the most appropriate format when the data will be displayed to the end user. The LRS will build its internal definitions of objects based on statements it receives and other authoritative sources. */ format?: "exact" | "ids" | "canonical"; }