Skip to main content Link Search Menu Expand Document (external link)
io

MetricPolling overview

Added in v1.0.0

Table of contents

constructors

collectAll

Collects all of the polling metrics into a single polling metric, which polls for, updates, and produces the outputs of all individual metrics.

Signature

export declare const collectAll: <R, E, Out>(
  iterable: Iterable<PollingMetric<any, any, R, E, Out>>
) => PollingMetric<any[], any[], R, E, Out[]>

Added in v1.0.0

make

Constructs a new polling metric from a metric and poll effect.

Signature

export declare const make: <Type, In, Out, R, E>(
  metric: Metric.Metric<Type, In, Out>,
  poll: Effect.Effect<R, E, In>
) => PollingMetric<Type, In, R, E, Out>

Added in v1.0.0

retry

Returns a new polling metric whose poll function will be retried with the specified retry policy.

Signature

export declare const retry: {
  <R2, E, _>(policy: Schedule.Schedule<R2, E, _>): <Type, In, R, Out>(
    self: PollingMetric<Type, In, R, E, Out>
  ) => PollingMetric<Type, In, R2 | R, E, Out>
  <Type, In, R, Out, R2, E, _>(
    self: PollingMetric<Type, In, R, E, Out>,
    policy: Schedule.Schedule<R2, E, _>
  ): PollingMetric<Type, In, R | R2, E, Out>
}

Added in v1.0.0

models

PollingMetric (interface)

A PollingMetric is a combination of a metric and an effect that polls for updates to the metric.

Signature

export interface PollingMetric<Type, In, R, E, Out> extends Pipeable {
  readonly [PollingMetricTypeId]: PollingMetricTypeId
  /**
   * The metric that this `PollingMetric` 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<R, E, In>
}

Added in v1.0.0

symbols

PollingMetricTypeId

Signature

export declare const PollingMetricTypeId: typeof PollingMetricTypeId

Added in v1.0.0

PollingMetricTypeId (type alias)

Signature

export type PollingMetricTypeId = typeof PollingMetricTypeId

Added in v1.0.0

utils

launch

Returns an effect that will launch the polling metric in a background fiber, using the specified schedule.

Signature

export declare const launch: {
  <R2, A2>(schedule: Schedule.Schedule<R2, unknown, A2>): <Type, In, R, E, Out>(
    self: PollingMetric<Type, In, R, E, Out>
  ) => Effect.Effect<Scope.Scope | R2 | R, never, Fiber.Fiber<E, A2>>
  <Type, In, R, E, Out, R2, A2>(
    self: PollingMetric<Type, In, R, E, Out>,
    schedule: Schedule.Schedule<R2, unknown, A2>
  ): Effect.Effect<Scope.Scope | R | R2, never, Fiber.Fiber<E, A2>>
}

Added in v1.0.0

poll

An effect that polls a value that may be fed to the metric.

Signature

export declare const poll: <Type, In, R, E, Out>(self: PollingMetric<Type, In, R, E, Out>) => Effect.Effect<R, E, In>

Added in v1.0.0

pollAndUpdate

An effect that polls for a value and uses the value to update the metric.

Signature

export declare const pollAndUpdate: <Type, In, R, E, Out>(
  self: PollingMetric<Type, In, R, E, Out>
) => Effect.Effect<R, E, void>

Added in v1.0.0

zip

Zips this polling metric with the specified polling metric.

Signature

export declare const zip: {
  <Type2, In2, R2, E2, Out2>(that: PollingMetric<Type2, In2, R2, E2, Out2>): <Type, In, R, E, Out>(
    self: PollingMetric<Type, In, R, E, Out>
  ) => PollingMetric<readonly [Type, Type2], readonly [In, In2], R2 | R, E2 | E, readonly [Out, Out2]>
  <Type, In, R, E, Out, Type2, In2, R2, E2, Out2>(
    self: PollingMetric<Type, In, R, E, Out>,
    that: PollingMetric<Type2, In2, R2, E2, Out2>
  ): PollingMetric<readonly [Type, Type2], readonly [In, In2], R | R2, E | E2, readonly [Out, Out2]>
}

Added in v1.0.0