Lorem Ipsum MCP Server

/** * @since 2.0.0 */ import type * as Effect from "./Effect.js" import type * as Fiber from "./Fiber.js" import * as internal from "./internal/metric/polling.js" import type * as Metric from "./Metric.js" import type { Pipeable } from "./Pipeable.js" import type * as Schedule from "./Schedule.js" import type * as Scope from "./Scope.js" /** * @since 2.0.0 * @category symbols */ export const MetricPollingTypeId: unique symbol = internal.MetricPollingTypeId /** * @since 2.0.0 * @category symbols */ export type MetricPollingTypeId = typeof MetricPollingTypeId /** * A `MetricPolling` is a combination of a metric and an effect that polls for * updates to the metric. * * @since 2.0.0 * @category models */ export interface MetricPolling<in out Type, in out In, out R, out E, out Out> extends Pipeable { readonly [MetricPollingTypeId]: MetricPollingTypeId /** * The metric that this `MetricPolling` polls to update. */ readonly metric: Metric.Metric<Type, In, Out> /** * An effect that polls a value that may be fed to the metric. */ readonly poll: Effect.Effect<In, E, R> } /** * Constructs a new polling metric from a metric and poll effect. * * @since 2.0.0 * @category constructors */ export const make: <Type, In, Out, R, E>( metric: Metric.Metric<Type, In, Out>, poll: Effect.Effect<In, E, R> ) => MetricPolling<Type, In, R, E, Out> = internal.make /** * Collects all of the polling metrics into a single polling metric, which * polls for, updates, and produces the outputs of all individual metrics. * * @since 2.0.0 * @category constructors */ export const collectAll: <R, E, Out>( iterable: Iterable<MetricPolling<any, any, R, E, Out>> ) => MetricPolling<Array<any>, Array<any>, R, E, Array<Out>> = internal.collectAll /** * Returns an effect that will launch the polling metric in a background * fiber, using the specified schedule. * * @since 2.0.0 * @category utils */ export const launch: { /** * Returns an effect that will launch the polling metric in a background * fiber, using the specified schedule. * * @since 2.0.0 * @category utils */ <A2, R2>(schedule: Schedule.Schedule<A2, unknown, R2>): <Type, In, R, E, Out>( self: MetricPolling<Type, In, R, E, Out> ) => Effect.Effect<Fiber.Fiber<A2, E>, never, R2 | R | Scope.Scope> /** * Returns an effect that will launch the polling metric in a background * fiber, using the specified schedule. * * @since 2.0.0 * @category utils */ <Type, In, R, E, Out, A2, R2>( self: MetricPolling<Type, In, R, E, Out>, schedule: Schedule.Schedule<A2, unknown, R2> ): Effect.Effect<Fiber.Fiber<A2, E>, never, Scope.Scope | R | R2> } = internal.launch /** * An effect that polls a value that may be fed to the metric. * * @since 2.0.0 * @category utils */ export const poll: <Type, In, R, E, Out>(self: MetricPolling<Type, In, R, E, Out>) => Effect.Effect<In, E, R> = internal.poll /** * An effect that polls for a value and uses the value to update the metric. * * @since 2.0.0 * @category utils */ export const pollAndUpdate: <Type, In, R, E, Out>( self: MetricPolling<Type, In, R, E, Out> ) => Effect.Effect<void, E, R> = internal.pollAndUpdate /** * Returns a new polling metric whose poll function will be retried with the * specified retry policy. * * @since 2.0.0 * @category constructors */ export const retry: { /** * Returns a new polling metric whose poll function will be retried with the * specified retry policy. * * @since 2.0.0 * @category constructors */ <X, E, R2>(policy: Schedule.Schedule<X, NoInfer<E>, R2>): <Type, In, R, Out>(self: MetricPolling<Type, In, R, E, Out>) => MetricPolling<Type, In, R2 | R, E, Out> /** * Returns a new polling metric whose poll function will be retried with the * specified retry policy. * * @since 2.0.0 * @category constructors */ <Type, In, R, E, Out, X, R2>( self: MetricPolling<Type, In, R, E, Out>, policy: Schedule.Schedule<X, E, R2> ): MetricPolling<Type, In, R | R2, E, Out> } = internal.retry /** * Zips this polling metric with the specified polling metric. * * @since 2.0.0 * @category utils */ export const zip: { /** * Zips this polling metric with the specified polling metric. * * @since 2.0.0 * @category utils */ <Type2, In2, R2, E2, Out2>(that: MetricPolling<Type2, In2, R2, E2, Out2>): <Type, In, R, E, Out>( self: MetricPolling<Type, In, R, E, Out> ) => MetricPolling< readonly [Type, Type2], // readonly because invariant readonly [In, In2], // readonly because contravariant R2 | R, E2 | E, [Out, Out2] > /** * Zips this polling metric with the specified polling metric. * * @since 2.0.0 * @category utils */ <Type, In, R, E, Out, Type2, In2, R2, E2, Out2>( self: MetricPolling<Type, In, R, E, Out>, that: MetricPolling<Type2, In2, R2, E2, Out2> ): MetricPolling< readonly [Type, Type2], // readonly because invariant readonly [In, In2], // readonly because contravariant R | R2, E | E2, [Out, Out2] > } = internal.zip