@effect-ts/system/_src/Experimental/Stream/_internal/api/throttleEnforce.ts

Effect-TS is a zero dependency set of libraries to write highly productive, purely functional TypeScript at scale.

// ets_tracing: off

import type * as CL from "../../../../Clock/index.js"
import type * as CK from "../../../../Collections/Immutable/Chunk/index.js"
import * as T from "../../../../Effect/index.js"
import type * as C from "../core.js"
import * as ThrottleEnforceEffect from "./throttleEnforceEffect.js"

/**
 * Throttles the chunks of this stream according to the given bandwidth parameters using the token bucket
 * algorithm. Allows for burst in the processing of elements by allowing the token bucket to accumulate
 * tokens up to a `units + burst` threshold. Chunks that do not meet the bandwidth constraints are dropped.
 * The weight of each chunk is determined by the `costFn` function.
 */
export function throttleEnforce_<R, E, A>(
  self: C.Stream<R, E, A>,
  units: number,
  duration: number,
  costFn: (c: CK.Chunk<A>) => number,
  burst = 0
): C.Stream<CL.HasClock & R, E, A> {
  return ThrottleEnforceEffect.throttleEnforceEffect_(
    self,
    units,
    duration,
    (as) => T.succeed(costFn(as)),
    burst
  )
}

/**
 * Throttles the chunks of this stream according to the given bandwidth parameters using the token bucket
 * algorithm. Allows for burst in the processing of elements by allowing the token bucket to accumulate
 * tokens up to a `units + burst` threshold. Chunks that do not meet the bandwidth constraints are dropped.
 * The weight of each chunk is determined by the `costFn` function.
 *
 * @ets_data_first throttleEnforce_
 */
export function throttleEnforce<A>(
  units: number,
  duration: number,
  costFn: (c: CK.Chunk<A>) => number,
  burst = 0
) {
  return <R, E>(self: C.Stream<R, E, A>) =>
    throttleEnforce_(self, units, duration, costFn, burst)
}