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

MetricPair.ts overview

Since v2.0.0

Exports Grouped by Category

constructors

make

Signature

declare const make: <Type extends MetricKeyType.MetricKeyType<any, any>>(
  metricKey: MetricKey.MetricKey<Type>,
  metricState: MetricState.MetricState<MetricKeyType.MetricKeyType.OutType<Type>>
) => MetricPair.Untyped

Source

Since v2.0.0

model

MetricPair (interface)

Signature

export interface MetricPair<out Type extends MetricKeyType.MetricKeyType<any, any>>
  extends MetricPair.Variance<Type>,
    Pipeable {
  readonly metricKey: MetricKey.MetricKey<Type>
  readonly metricState: MetricState.MetricState<MetricKeyType.MetricKeyType.OutType<Type>>
}

Source

Since v2.0.0

symbols

MetricPairTypeId

Signature

declare const MetricPairTypeId: unique symbol

Source

Since v2.0.0

MetricPairTypeId (type alias)

Signature

type MetricPairTypeId = typeof MetricPairTypeId

Source

Since v2.0.0

unsafe

unsafeMake

Signature

declare const unsafeMake: <Type extends MetricKeyType.MetricKeyType<any, any>>(
  metricKey: MetricKey.MetricKey<Type>,
  metricState: MetricState.MetricState.Untyped
) => MetricPair.Untyped

Source

Since v2.0.0

utils

MetricPair (namespace)

Source

Since v2.0.0

Untyped (interface)

Signature

export interface Untyped extends MetricPair<MetricKeyType.MetricKeyType<any, any>> {}

Source

Since v2.0.0

Variance (interface)

Signature

export interface Variance<out Type extends MetricKeyType.MetricKeyType<any, any>> {
  readonly [MetricPairTypeId]: {
    readonly _Type: Types.Covariant<Type>
  }
}

Source

Since v2.0.0