Duration

Represents a duration in milliseconds between two timestamps.

Hierarchy

• TinyType
  • Duration

Index

Methods

• ofMilliseconds
• ofSeconds
• ofMinutes
• ofHours
• ofDays
• ofYears
• fromJSON
• equals
• isLessThan
• isLessThanOrEqualTo
• isGreaterThan
• isGreaterThanOrEqualTo
• plus
• inMilliseconds
• toString
• toJSON

Constructors

• constructor

Methods

staticofMilliseconds

• ofMilliseconds(milliseconds: number): Duration

• Parameters

  • milliseconds: number

  Returns Duration

staticofSeconds

• ofSeconds(seconds: number): Duration

• Parameters

  • seconds: number

  Returns Duration

staticofMinutes

• ofMinutes(minutes: number): Duration

• Parameters

  • minutes: number

  Returns Duration

staticofHours

• ofHours(hours: number): Duration

• Parameters

  • hours: number

  Returns Duration

staticofDays

• ofDays(days: number): Duration

• Parameters

  • days: number

  Returns Duration

staticofYears

• ofYears(years: number): Duration

• Parameters

  • years: number

  Returns Duration

staticfromJSON

• fromJSON(__namedParameters: { milliseconds: number }): Duration

• Parameters

  • __namedParameters: { milliseconds: number }

  Returns Duration

externalequals

• equals(another: TinyType): boolean

• Inherited from TinyType.equals

  @desc

  Compares two tiny types by value

  @example

  <caption>Comparing simple types</caption> class Id extends TinyTypeOf<string>() {}

  const id = new Id(3cc0852d-fda7-4f61-874e-0cfadbd6182a);

  id.equals(id) === true

  @example

  Comparing complex types recursively

  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

isLessThan

• isLessThan(another: Duration): boolean

• Parameters

  • another: Duration

  Returns boolean

isLessThanOrEqualTo

• isLessThanOrEqualTo(another: Duration): boolean

• Parameters

  • another: Duration

  Returns boolean

isGreaterThan

• isGreaterThan(another: Duration): boolean

• Parameters

  • another: Duration

  Returns boolean

isGreaterThanOrEqualTo

• isGreaterThanOrEqualTo(another: Duration): boolean

• Parameters

  • another: Duration

  Returns boolean

plus

• plus(another: Duration): Duration

• Parameters

  • another: Duration

  Returns Duration

inMilliseconds

• inMilliseconds(): number

• Returns number

toString

• toString(): string

• Overrides TinyType.toString

  Returns string

toJSON

• toJSON(): JSONObject

• Overrides TinyType.toJSON

  Returns JSONObject

Constructors

constructor

• new Duration(milliseconds: number): Duration

• Overrides TinyType.constructor

  Parameters

  • milliseconds: number

  Returns Duration