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

Needs overview

Helper types for requiring certain packages to be installed.

Added in v1.0.0


Table of contents


Types

NeedsNodeHttp (type alias)

Signature

export type NeedsNodeHttp<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> = HasPackage<typeof import("node:http")> extends "yes" ? Dependent : 'Missing "node:http" package'

Added in v1.0.0

NeedsNodeHttps (type alias)

Signature

export type NeedsNodeHttps<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> = HasPackage<typeof import("node:https")> extends "yes" ? Dependent : 'Missing "node:https" package'

Added in v1.0.0

NeedsPlatformBrowser (type alias)

Signature

export type NeedsPlatformBrowser<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> =
  HasPackage<typeof import("@effect/platform-browser")> extends "yes"
    ? Dependent
    : 'Missing "@effect/platform-browser" package'

Added in v1.0.0

NeedsPlatformBun (type alias)

Signature

export type NeedsPlatformBun<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> =
  HasPackage<typeof import("@effect/platform-bun")> extends "yes" ? Dependent : 'Missing "@effect/platform-bun" package'

Added in v1.0.0

NeedsPlatformNode (type alias)

Signature

export type NeedsPlatformNode<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> =
  HasPackage<typeof import("@effect/platform-node")> extends "yes"
    ? Dependent
    : 'Missing "@effect/platform-node" package'

Added in v1.0.0

NeedsSSH2 (type alias)

Signature

export type NeedsSSH2<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> = HasPackage<typeof import("ssh2")> extends "yes" ? Dependent : 'Missing "ssh2" package'

Added in v1.0.0

NeedsUndici (type alias)

Signature

export type NeedsUndici<
  Dependent extends Effect.Effect<unknown, unknown, unknown> | Layer.Layer<unknown, unknown, unknown>
> = HasPackage<typeof import("undici")> extends "yes" ? Dependent : 'Missing "undici" package'

Added in v1.0.0