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

Redis.ts overview

Since v1.0.0


Exports Grouped by Category


Constructors

make

Signature

declare const make: (
  options: CommonRedisOptions &
    SentinelConnectionOptions &
    Partial<TcpOptions & IpcOptions> & { disconnectTimeout?: number; tls?: ConnectionOptions } & {
      readonly prefix?: string | undefined
      readonly pollInterval?: Duration.DurationInput | undefined
      readonly lockRefreshInterval?: Duration.DurationInput | undefined
      readonly lockExpiration?: Duration.DurationInput | undefined
    }
) => Effect.Effect<
  {
    readonly offer: (
      name: string,
      id: string,
      element: unknown
    ) => Effect.Effect<void, PersistedQueue.PersistedQueueError>
    readonly take: (options: {
      readonly name: string
      readonly maxAttempts: number
    }) => Effect.Effect<
      { readonly id: string; readonly attempts: number; readonly element: unknown },
      PersistedQueue.PersistedQueueError,
      Scope
    >
  },
  never,
  Scope
>

Source

Since v1.0.0

Layers

layerStore

Signature

declare const layerStore: (
  options: RedisOptions & {
    readonly prefix?: string | undefined
    readonly pollInterval?: Duration.DurationInput | undefined
    readonly lockRefreshInterval?: Duration.DurationInput | undefined
    readonly lockExpiration?: Duration.DurationInput | undefined
  }
) => Layer.Layer<PersistedQueue.PersistedQueueStore, never, never>

Source

Since v1.0.0

layerStoreConfig

Signature

declare const layerStoreConfig: (
  options: Config.Config.Wrap<RedisOptions & { readonly prefix?: string | undefined }>
) => Layer.Layer<PersistedQueue.PersistedQueueStore, ConfigError, never>

Source

Since v1.0.0