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

Template overview

Added in v1.0.0


Table of contents


constructors

make

Signature

export declare function make<A extends ReadonlyArray<Interpolated>>(
  strings: TemplateStringsArray,
  ...args: A
): Effect.Effect<string, Interpolated.Error<A[number]>, Interpolated.Context<A[number]>>

Added in v1.0.0

stream

Signature

export declare function stream<A extends ReadonlyArray<InterpolatedWithStream>>(
  strings: TemplateStringsArray,
  ...args: A
): Stream.Stream<string, Interpolated.Error<A[number]>, Interpolated.Context<A[number]>>

Added in v1.0.0

models

Interpolated (type alias)

Signature

export type Interpolated = Primitive | Option.Option<Primitive> | Effect.Effect<Primitive, any, any>

Added in v1.0.0

Interpolated (namespace)

Added in v1.0.0

Context (type alias)

Signature

export type Context<A> = A extends infer T
  ? T extends Option.Option<infer _>
    ? never
    : T extends Stream.Stream<infer _A, infer _E, infer R>
      ? R
      : never
  : never

Added in v1.0.0

Error (type alias)

Signature

export type Error<A> = A extends infer T
  ? T extends Option.Option<infer _>
    ? never
    : T extends Stream.Stream<infer _A, infer E, infer _R>
      ? E
      : never
  : never

Added in v1.0.0

InterpolatedWithStream (type alias)

Signature

export type InterpolatedWithStream = Interpolated | Stream.Stream<Primitive, any, any>

Added in v1.0.0

Primitive (type alias)

Signature

export type Primitive = PrimitiveValue | ReadonlyArray<PrimitiveValue>

Added in v1.0.0

PrimitiveValue (type alias)

Signature

export type PrimitiveValue = string | number | bigint | boolean | null | undefined

Added in v1.0.0