JetStreamStream overview
Added in v0.1.0
Table of contents
models
JetStreamStream (interface)
Represents a JetStream stream
Signature
export interface JetStreamStream {
readonly [JetStreamStreamTypeId]: JetStreamStreamTypeId
readonly name: string
readonly info: (
...args: Parameters<JetStream.Stream["info"]>
) => Effect.Effect<JetStream.StreamInfo, NATSError.JetStreamStreamError>
readonly getMessage: (
...args: Parameters<JetStream.Stream["getMessage"]>
) => Effect.Effect<Option.Option<JetStreamStoredMessage.JetStreamStoredMessage>, NATSError.JetStreamStreamError>
readonly deleteMessage: (
...args: Parameters<JetStream.Stream["deleteMessage"]>
) => Effect.Effect<boolean, NATSError.JetStreamStreamError>
readonly alternates: Effect.Effect<Array<JetStream.StreamAlternate>, NATSError.JetStreamStreamError>
readonly best: Effect.Effect<JetStreamStream, NATSError.JetStreamStreamError>
readonly getConsumer: (
...args: Parameters<JetStream.Stream["getConsumer"]>
) => Effect.Effect<JetStreamConsumers.Consumer, NATSError.JetStreamStreamError>
/** @internal */
readonly stream: JetStream.Stream
}
Added in v0.1.0
JetStreamStreams (interface)
Represents streams API
Signature
export interface JetStreamStreams {
readonly [JetStreamStreamsTypeId]: JetStreamStreamsTypeId
readonly get: (
...args: Parameters<JetStream.Streams["get"]>
) => Effect.Effect<JetStreamStream, NATSError.JetStreamStreamError>
/** @internal */
readonly streams: JetStream.Streams
}
Added in v0.1.0
type ids
JetStreamStreamTypeId
Signature
export declare const JetStreamStreamTypeId: typeof JetStreamStreamTypeId
Added in v0.1.0
JetStreamStreamTypeId (type alias)
Signature
export type JetStreamStreamTypeId = typeof JetStreamStreamTypeId
Added in v0.1.0
JetStreamStreamsTypeId
Signature
export declare const JetStreamStreamsTypeId: typeof JetStreamStreamsTypeId
Added in v0.1.0
JetStreamStreamsTypeId (type alias)
Signature
export type JetStreamStreamsTypeId = typeof JetStreamStreamsTypeId
Added in v0.1.0