ZkgmClient.ts

Added in v2.0.0

accessors

execute

Signature

export declare const execute: (
  request: ClientRequest.ZkgmClientRequest
) => Effect.Effect<ClientResponse.ZkgmClientResponse, ClientError.ClientError, ZkgmClient>

Source: src/ZkgmClient.ts:77

Added in v2.0.0

constructors

make

Signature

export declare const make: (
  f: (
    request: ClientRequest.ZkgmClientRequest,
    signal: AbortSignal,
    fiber: RuntimeFiber<ClientResponse.ZkgmClientResponse, ClientError.ClientError>
  ) => Effect.Effect<ClientResponse.ZkgmClientResponse, ClientError.ClientError>
) => ZkgmClient

Source: src/ZkgmClient.ts:97

Added in v2.0.0

makeWith

Signature

export declare const makeWith: <E2, R2, E, R>(
  postprocess: (
    request: Effect.Effect<ClientRequest.ZkgmClientRequest, E2, R2>
  ) => Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>,
  preprocess: ZkgmClient.Preprocess<E2, R2>
) => ZkgmClient.With<E, R>

Source: src/ZkgmClient.ts:86

Added in v2.0.0

mapping & sequencing

transform

Signature

export declare const transform: {
  <E, R, E1, R1>(
    f: (
      effect: Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>,
      request: ClientRequest.ZkgmClientRequest
    ) => Effect.Effect<ClientResponse.ZkgmClientResponse, E1, R1>
  ): (self: ZkgmClient.With<E, R>) => ZkgmClient.With<E | E1, R | R1>
  <E, R, E1, R1>(
    self: ZkgmClient.With<E, R>,
    f: (
      effect: Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>,
      request: ClientRequest.ZkgmClientRequest
    ) => Effect.Effect<ClientResponse.ZkgmClientResponse, E1, R1>
  ): ZkgmClient.With<E | E1, R | R1>
}

Source: src/ZkgmClient.ts:109

Added in v2.0.0

transformResponse

Signature

export declare const transformResponse: {
  <E, R, E1, R1>(
    f: (
      effect: Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>
    ) => Effect.Effect<ClientResponse.ZkgmClientResponse, E1, R1>
  ): (self: ZkgmClient.With<E, R>) => ZkgmClient.With<E1, R1>
  <E, R, E1, R1>(
    self: ZkgmClient.With<E, R>,
    f: (
      effect: Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>
    ) => Effect.Effect<ClientResponse.ZkgmClientResponse, E1, R1>
  ): ZkgmClient.With<E1, R1>
}

Source: src/ZkgmClient.ts:129

Added in v1.0.0

models

ZkgmClient (interface)

Signature

export interface ZkgmClient extends ZkgmClient.With<ClientError.ClientError> {}

Source: src/ZkgmClient.ts:33

Added in v2.0.0

tags

ZkgmClient

Signature

export declare const ZkgmClient: Context.Tag<ZkgmClient, ZkgmClient>

Source: src/ZkgmClient.ts:71

Added in v2.0.0

tracing

SpanNameGenerator

Signature

export declare const SpanNameGenerator: Context.Reference<
  SpanNameGenerator,
  (request: ClientRequest.ZkgmClientRequest) => string
>

Source: src/ZkgmClient.ts:155

Added in v2.0.0-beta.3

SpanNameGenerator (interface)

Signature

export interface SpanNameGenerator {
  readonly _: unique symbol
}

Source: src/ZkgmClient.ts:147

Added in v2.0.0-beta.3

currentTracerDisabledWhen

Signature

export declare const currentTracerDisabledWhen: FiberRef.FiberRef<Predicate.Predicate<ClientRequest.ZkgmClientRequest>>

Source: src/ZkgmClient.ts:180

Added in v2.0.0-beta.3

withSpanNameGenerator

Customizes the span names for tracing.

Signature

export declare const withSpanNameGenerator: {
  (
    f: (request: ClientRequest.ZkgmClientRequest) => string
  ): <E, R>(self: ZkgmClient.With<E, R>) => ZkgmClient.With<E, R>
  <E, R>(self: ZkgmClient.With<E, R>, f: (request: ClientRequest.ZkgmClientRequest) => string): ZkgmClient.With<E, R>
}

Source: src/ZkgmClient.ts:166

Added in v2.0.0-beta.3

withTracerDisabledWhen

Disables tracing for specific requests based on a provided predicate.

Signature

export declare const withTracerDisabledWhen: {
  (
    predicate: Predicate.Predicate<ClientRequest.ZkgmClientRequest>
  ): <E, R>(self: ZkgmClient.With<E, R>) => ZkgmClient.With<E, R>
  <E, R>(
    self: ZkgmClient.With<E, R>,
    predicate: Predicate.Predicate<ClientRequest.ZkgmClientRequest>
  ): ZkgmClient.With<E, R>
}

Source: src/ZkgmClient.ts:190

Added in v2.0.0-beta.3

type ids

TypeId

Signature

export declare const TypeId: typeof TypeId

Source: src/ZkgmClient.ts:21

Added in v2.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Source: src/ZkgmClient.ts:27

Added in v2.0.0

utils

ZkgmClient (namespace)

Added in v2.0.0

With (interface)

Signature

export interface With<E, R = never> extends Pipeable, Inspectable {
  readonly [TypeId]: TypeId
  readonly execute: (request: ClientRequest.ZkgmClientRequest) => Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>
}

Source: src/ZkgmClient.ts:43

Added in v2.0.0

Postprocess (type alias)

Signature

export type Postprocess<E = never, R = never> = (
  request: Effect.Effect<ClientRequest.ZkgmClientRequest, E, R>
) => Effect.Effect<ClientResponse.ZkgmClientResponse, E, R>

Source: src/ZkgmClient.ts:62

Added in v2.0.0

Preprocess (type alias)

Signature

export type Preprocess<E, R> = (
  request: ClientRequest.ZkgmClientRequest
) => Effect.Effect<ClientRequest.ZkgmClientRequest, E, R>

Source: src/ZkgmClient.ts:54

Added in v2.0.0

layerMergedContext

Signature

export declare const layerMergedContext: <E, R>(effect: Effect.Effect<ZkgmClient, E, R>) => Layer<ZkgmClient, E, R>

Source: src/ZkgmClient.ts:203

Added in v2.0.0