97 lines
2.3 KiB
TypeScript
97 lines
2.3 KiB
TypeScript
/**
|
|
* @since 2.0.0
|
|
*/
|
|
import type * as Context from "./Context.js";
|
|
import type * as Duration from "./Duration.js";
|
|
import type * as Effect from "./Effect.js";
|
|
/**
|
|
* @since 2.0.0
|
|
* @category symbols
|
|
*/
|
|
export declare const ClockTypeId: unique symbol;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category symbols
|
|
*/
|
|
export type ClockTypeId = typeof ClockTypeId;
|
|
/**
|
|
* Represents a time-based clock which provides functionality related to time
|
|
* and scheduling.
|
|
*
|
|
* @since 2.0.0
|
|
* @category models
|
|
*/
|
|
export interface Clock {
|
|
readonly [ClockTypeId]: ClockTypeId;
|
|
/**
|
|
* Unsafely returns the current time in milliseconds.
|
|
*/
|
|
unsafeCurrentTimeMillis(): number;
|
|
/**
|
|
* Returns the current time in milliseconds.
|
|
*/
|
|
readonly currentTimeMillis: Effect.Effect<number>;
|
|
/**
|
|
* Unsafely returns the current time in nanoseconds.
|
|
*/
|
|
unsafeCurrentTimeNanos(): bigint;
|
|
/**
|
|
* Returns the current time in nanoseconds.
|
|
*/
|
|
readonly currentTimeNanos: Effect.Effect<bigint>;
|
|
/**
|
|
* Asynchronously sleeps for the specified duration.
|
|
*/
|
|
sleep(duration: Duration.Duration): Effect.Effect<void>;
|
|
}
|
|
/**
|
|
* @since 2.0.0
|
|
* @category models
|
|
*/
|
|
export type CancelToken = () => boolean;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category models
|
|
*/
|
|
export type Task = () => void;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category models
|
|
*/
|
|
export interface ClockScheduler {
|
|
/**
|
|
* Unsafely schedules the specified task for the specified duration.
|
|
*/
|
|
unsafeSchedule(task: Task, duration: Duration.Duration): CancelToken;
|
|
}
|
|
/**
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export declare const make: (_: void) => Clock;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export declare const sleep: (duration: Duration.DurationInput) => Effect.Effect<void>;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export declare const currentTimeMillis: Effect.Effect<number>;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export declare const currentTimeNanos: Effect.Effect<bigint>;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category constructors
|
|
*/
|
|
export declare const clockWith: <A, E, R>(f: (clock: Clock) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>;
|
|
/**
|
|
* @since 2.0.0
|
|
* @category context
|
|
*/
|
|
export declare const Clock: Context.Tag<Clock, Clock>;
|
|
//# sourceMappingURL=Clock.d.ts.map
|