@effect-ts/system/_src/Testing/Live/index.ts

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

// ets_tracing: off

import * as T from "../../Effect/index.js"
import { tag } from "../../Has/index.js"
import * as L from "../../Layer/index.js"

export const LiveId = Symbol.for("@effect-ts/system/Test/LiveId")

/**
 * The `Live` trait provides access to the "live" environment from within the
 * test environment for effects such as printing test results to the console or
 * timing out tests where it is necessary to access the real environment.
 *
 * The easiest way to access the "live" environment is to use the `live` method
 * with an effect that would otherwise access the test environment.
 *
 * The `withLive` method can be used to apply a transformation to an effect
 * with the live environment while ensuring that the effect itself still runs
 * with the test environment, for example to time out a test. Both of these
 * methods are re-exported in the `environment` package for easy availability.
 */
export interface Live {
  readonly serviceId: typeof LiveId

  readonly provide: <E, A>(
    effect: T.Effect<T.DefaultEnv, E, A>
  ) => T.Effect<unknown, E, A>
}

export const Live = tag<Live>(LiveId)

export const live = L.fromEffect(Live)(
  T.access((r: T.DefaultEnv) => ({
    serviceId: LiveId,
    provide: T.provideAll(r)
  }))
)