@stencila/types/src/types/Timestamp.ts

JavaScript classes and TypeScript types for the Stencila Schema

// Generated file; do not edit. See https://github.com/stencila/stencila/tree/main/rust/schema-gen

import { Entity } from "./Entity.js";
import { Integer } from "./Integer.js";
import { TimeUnit } from "./TimeUnit.js";

/**
 * A value that represents a point in time.
 */
export class Timestamp extends Entity {
  // @ts-expect-error 'not assignable to the same property in base type'
  type: "Timestamp";

  /**
   * The time, in `timeUnit`s, before or after the Unix Epoch (1970-01-01T00:00:00Z).
   */
  value: Integer;

  /**
   * The time unit that the `value` represents.
   */
  timeUnit: TimeUnit;

  constructor(value: Integer, timeUnit: TimeUnit, options?: Partial<Timestamp>) {
    super();
    this.type = "Timestamp";
    if (options) Object.assign(this, options);
    this.value = value;
    this.timeUnit = timeUnit;
  }
}

/**
* Create a new `Timestamp`
*/
export function timestamp(value: Integer, timeUnit: TimeUnit, options?: Partial<Timestamp>): Timestamp {
  return new Timestamp(value, timeUnit, options);
}