diff --git a/CHANGELOG.md b/CHANGELOG.md index ee25389..68255e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- **BREAKING CHANGE**: rename type `DataPoint` to `Event` - rename enums to singular - improve doc comments diff --git a/src/query-data/response.ts b/src/query-data/response.ts index 78ed2d8..f9fac30 100644 --- a/src/query-data/response.ts +++ b/src/query-data/response.ts @@ -18,18 +18,18 @@ export interface QueryResponseItem { /** * data contains the data retrieved from the API. */ - data: DataPoint[] + data: Event[] } /** - * DataPoint defines a single point of data returned for a [[Channel]] + * Event defines a single point of data returned for a [[Channel]] * within a [[QueryResponseItem]]. * * @remarks * Which fields are present depends on which fields were requested in * the original data query. */ -export interface DataPoint { +export interface Event { [EventField.GLOBAL_DATE]?: string [EventField.GLOBAL_MILLIS]?: number [EventField.GLOBAL_SECONDS]?: number