JetStreamConsumerAPI overview
Added in v0.1.0
Table of contents
models
JetStreamConsumerAPI (interface)
Represents a NATS JetStream Consumer API
Signature
export interface JetStreamConsumerAPI {
readonly [TypeId]: TypeId
readonly add: (
...params: Parameters<JetStream.ConsumerAPI["add"]>
) => Effect.Effect<JetStream.ConsumerInfo, NATSError.JetStreamConsumerAPIError, never>
readonly update: (
...params: Parameters<JetStream.ConsumerAPI["update"]>
) => Effect.Effect<JetStream.ConsumerInfo, NATSError.JetStreamConsumerAPIError, never>
readonly info: (
...params: Parameters<JetStream.ConsumerAPI["info"]>
) => Effect.Effect<JetStream.ConsumerInfo, NATSError.JetStreamConsumerAPIError, never>
readonly delete: (
...params: Parameters<JetStream.ConsumerAPI["delete"]>
) => Effect.Effect<boolean, NATSError.JetStreamConsumerAPIError, never>
readonly list: (
...params: Parameters<JetStream.ConsumerAPI["list"]>
) => Effect.Effect<
JetStreamLister.JetStreamLister<JetStream.ConsumerInfo, NATSError.JetStreamConsumerAPIError>,
NATSError.JetStreamConsumerAPIError,
never
>
readonly pause: (...params: Parameters<JetStream.ConsumerAPI["pause"]>) => Effect.Effect<
{
paused: boolean
pause_until?: string
},
NATSError.JetStreamConsumerAPIError,
never
>
readonly resume: (...params: Parameters<JetStream.ConsumerAPI["resume"]>) => Effect.Effect<
{
paused: boolean
pause_until?: string
},
NATSError.JetStreamConsumerAPIError,
never
>
readonly unpin: (
...params: Parameters<JetStream.ConsumerAPI["unpin"]>
) => Effect.Effect<void, NATSError.JetStreamConsumerAPIError, never>
/** @internal */
readonly consumers: JetStream.ConsumerAPI
}
Added in v0.1.0
type ids
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v0.1.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v0.1.0