Admin overview
Added in v0.7.0
Table of contents
accessors
listTopics
List all topics in the Kafka cluster.
Signature
export declare const listTopics: () => Effect.Effect<ReadonlyArray<string>, AdminError.AdminError, Admin>
Added in v0.7.0
constructors
Admin
Signature
export declare const Admin: Context.Tag<Admin, Admin>
Added in v0.7.0
make
Signature
export declare const make: (options: internal.AdminConstructorProps) => Admin
Added in v0.7.0
makeAdmin
Signature
export declare const makeAdmin: (
options?: Admin.AdminOptions
) => Effect.Effect<Admin, Error.ConnectionException, KafkaInstance.KafkaInstance | Scope.Scope>
Added in v0.7.0
layers
layer
Signature
export declare const layer: (
options?: Admin.AdminOptions
) => Layer.Layer<Admin, Error.ConnectionException, KafkaInstance.KafkaInstance>
Added in v0.7.0
models
Admin (interface)
Signature
export interface Admin extends internal.AdminConstructorProps {
readonly [TypeId]: TypeId
}
Added in v0.7.0
type ids
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v0.7.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v0.7.0
utils
Admin (namespace)
Added in v0.7.0
AdminOptions (interface)
Signature
export interface AdminOptions {}
Added in v0.7.0