externalTimestamp

Represents a point in time.

Timestamp makes it easier for you to work with information related to time, like Serenity/JS domain events.

Learn more

• Duration
• Date

Hierarchy

• TinyType
  • Timestamp

Index

Constructors

• constructor

Properties

• value

Methods

• fromJSON
• fromTimestampInSeconds
• fromTimestampInMilliseconds
• now
• diff
• plus
• less
• isBefore
• isBeforeOrEqual
• isAfter
• isAfterOrEqual
• toMilliseconds
• toSeconds
• toJSON
• toISOString
• toString
• [custom]
• equals

Constructors

externalconstructor

• new Timestamp(value?: Date): Timestamp

• Overrides TinyType.constructor

  Parameters

  • externalvalue: Date = ...

  Returns Timestamp

Properties

publicexternalreadonlyvalue

value: Date = ...

Methods

staticexternalfromJSON

• fromJSON(v: string): Timestamp

• Parameters

  • externalv: string

  Returns Timestamp

staticexternalfromTimestampInSeconds

• fromTimestampInSeconds(value: number): Timestamp

• Parameters

  • externalvalue: number

  Returns Timestamp

staticexternalfromTimestampInMilliseconds

• fromTimestampInMilliseconds(value: number): Timestamp

• Parameters

  • externalvalue: number

  Returns Timestamp

staticexternalnow

• now(): Timestamp

• Returns Timestamp

externaldiff

• diff(another: Timestamp): Duration

• Parameters

  • externalanother: Timestamp

  Returns Duration

externalplus

• plus(duration: Duration): Timestamp

• Parameters

  • externalduration: Duration

  Returns Timestamp

externalless

• less(duration: Duration): Timestamp

• Parameters

  • externalduration: Duration

  Returns Timestamp

externalisBefore

• isBefore(another: Timestamp): boolean

• Parameters

  • externalanother: Timestamp

  Returns boolean

externalisBeforeOrEqual

• isBeforeOrEqual(another: Timestamp): boolean

• Parameters

  • externalanother: Timestamp

  Returns boolean

externalisAfter

• isAfter(another: Timestamp): boolean

• Parameters

  • externalanother: Timestamp

  Returns boolean

externalisAfterOrEqual

• isAfterOrEqual(another: Timestamp): boolean

• Parameters

  • externalanother: Timestamp

  Returns boolean

externaltoMilliseconds

• toMilliseconds(): number

• Returns number

externaltoSeconds

• toSeconds(): number

• Returns number

externaltoJSON

• toJSON(): string

• Overrides TinyType.toJSON

  Returns string

externaltoISOString

• toISOString(): string

• Returns string

externaltoString

• toString(): string

• Overrides TinyType.toString

  Returns string

external[custom]

• [custom](): string

• Returns string

externalequals

• equals(another: TinyType): boolean

• Inherited from TinyType.equals

  @desc

  Compares two tiny types by value

  @example

  class Id extends TinyTypeOf<string>() {}
  
  const id = new Id(`3cc0852d-fda7-4f61-874e-0cfadbd6182a`);
  
  id.equals(id) === true

  @example

  class FirstName extends TinyTypeOf<string>() {}
  class LastName  extends TinyTypeOf<string>() {}
  class Age       extends TinyTypeOf<number>() {}
  
  class Person extends TinyType {
    constructor(public readonly firstName: FirstName,
                public readonly lastName:  LastName,
                public readonly age:       Age,
    ) {
      super();
    }
  }
  
  const p1 = new Person(new FirstName('John'), new LastName('Smith'), new Age(42)),
        p2 = new Person(new FirstName('John'), new LastName('Smith'), new Age(42));
  
  p1.equals(p2) === true

  ---

  Parameters

  • externalanother: TinyType

  Returns boolean