KevinFabre-ods
released this
05 Sep 09:44
·
17 commits
to main
since this release
Release Note: TypeScript Types Update
This update focuses on improving TypeScript types within the codebase. Below is a summary of the changes introduced:
Major Changes:
- Type Prefix Removal: All TypeScript types no longer have the
Ods
prefix. - Dataset Type Update:
- The
Dataset
type has been modified: keys are no longer optional. - New keys have been added to the
Dataset
type, such asattachments
andalternative_exports
.
- The
New Type Introduced:
- A new
DatasetFieldType
has been created for handling dataset field types.
Type Renaming:
ApiRecords
has been renamed toApiDatasetRecords
.ApiDatasets
has been renamed toApiCatalog
.
Usage Guidelines:
Use ApiDatasetRecords
and ApiCatalog
when querying data without the group_by
parameter. If you are using the group_by
parameter, use the ApiQuery
type along with the generic type for ApiQuery
. When using the select clause while fetching a catalog, you can pass a type to override the default generic type Dataset
.