Class Time

Time related utilities.

Index

Constructors

Methods

createOffsetTimestamp createTimestamp getCurrentTimestamp minimalSleep sleep validateTimestamp

Constructors

constructor

new Time(): Time
Returns Time

Methods

`Static`createOffsetTimestamp

createOffsetTimestamp(offset, timestamp?): string
Creates a UTC ISO-8601 timestamp offset from now or given timestamp accepted by DWN.
Parameters
- offset: {
  seconds: number;
  }
  Negative number means offset into the past.
  - seconds: number
- Optionaltimestamp: string
Returns string
- Defined in src/utils/time.ts:59

`Static`createTimestamp

createTimestamp(options): string
Creates a UTC ISO-8601 timestamp in microsecond precision accepted by DWN.
Parameters
- options: {
      day?: number;
      hour?: number;
      microsecond?: number;
      millisecond?: number;
      minute?: number;
      month?: number;
      second?: number;
      year?: number;
  }
  Options for creating the timestamp.
  - Optionalday?: number
  - Optionalhour?: number
  - Optionalmicrosecond?: number
  - Optionalmillisecond?: number
  - Optionalminute?: number
  - Optionalmonth?: number
  - Optionalsecond?: number
  - Optionalyear?: number
Returns string
string
- Defined in src/utils/time.ts:38

`Static`getCurrentTimestamp

getCurrentTimestamp(): string
Returns an UTC ISO-8601 timestamp with microsecond precision accepted by DWN. using @js-temporal/polyfill

Returns string
- Defined in src/utils/time.ts:29

`Static`minimalSleep

minimalSleep(): Promise<void>
We must sleep for at least 2ms to avoid timestamp collisions during testing. https://github.com/TBD54566975/dwn-sdk-js/issues/481

Returns Promise<void>
- Defined in src/utils/time.ts:21

`Static`sleep

sleep(durationInMillisecond): Promise<void>
sleeps for the desired duration
Parameters
- durationInMillisecond: number
  the desired amount of sleep time
Returns Promise<void>
when the provided duration has passed
- Defined in src/utils/time.ts:13

`Static`validateTimestamp

validateTimestamp(timestamp): void
Validates that the provided timestamp is a valid number
Parameters
- timestamp: string
  the timestamp to validate
Returns void
Throws
DwnError if timestamp is not a valid number
- Defined in src/utils/time.ts:71