From d527a7de6eb41eb59e637c19a83f90ef2fa17708 Mon Sep 17 00:00:00 2001 From: Oscar Lorentzon Date: Mon, 7 Jun 2021 22:28:00 +0200 Subject: [PATCH] docs: clarify captured at timestamp --- src/api/ents/SpatialImageEnt.ts | 4 +++- src/graph/Image.ts | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/api/ents/SpatialImageEnt.ts b/src/api/ents/SpatialImageEnt.ts index 6ab55a84..f9de7889 100644 --- a/src/api/ents/SpatialImageEnt.ts +++ b/src/api/ents/SpatialImageEnt.ts @@ -21,7 +21,9 @@ export interface SpatialImageEnt extends CameraEnt, IDEnt { atomic_scale?: number; /** - * Timestamp when the image was captured. + * Timestamp representing the capture date and time. + * + * @description Unix epoch timestamp in milliseconds. */ captured_at: number; diff --git a/src/graph/Image.ts b/src/graph/Image.ts index d6de699e..81e30fba 100644 --- a/src/graph/Image.ts +++ b/src/graph/Image.ts @@ -125,6 +125,9 @@ export class Image { /** * Get capturedAt. * + * @description Timestamp of the image capture date + * and time represented as a Unix epoch timestamp in milliseconds. + * * @returns {number} Timestamp when the image was captured. */ public get capturedAt(): number {