apache-iggy 0.6.0 → 0.7.0

package/dist/type.utils.js

@@ -16,6 +16,15 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Reverses the keys and values of a record object.
+ * Creates a new record where the original values become keys and vice versa.
+ *
+ * @typeParam T - Type of the original keys
+ * @typeParam U - Type of the original values (becomes keys in result)
+ * @param input - Record object to reverse
+ * @returns New record with swapped keys and values
+ */
 export function reverseRecord(input) {
     return Object.fromEntries(Object.entries(input).map(([key, value]) => [
         value,

package/dist/wire/command-set.d.ts

@@ -56,18 +56,11 @@ declare const streamAPI: (c: ClientProvider) => {
 };
 type StreamAPI = ReturnType<typeof streamAPI>;
 declare const topicAPI: (c: ClientProvider) => {
-    get: (arg: {
-        streamId: import("./identifier.utils.js").Id;
-        topicId: import("./identifier.utils.js").Id;
-    }) => Promise<import("./topic/topic.utils.js").Topic | null>;
+    get: (arg: import("./topic/get-topic.command.js").GetTopic) => Promise<import("./topic/topic.utils.js").Topic | null>;
     list: (arg: import("./topic/get-topics.command.js").GetTopics) => Promise<import("./topic/topic.utils.js").Topic[]>;
     create: (arg: import("./topic/create-topic.command.js").CreateTopic) => Promise<import("./topic/topic.utils.js").Topic>;
     update: (arg: import("./topic/update-topic.command.js").UpdateTopic) => Promise<boolean>;
-    delete: (arg: {
-        streamId: import("./identifier.utils.js").Id;
-        topicId: import("./identifier.utils.js").Id;
-        partitionsCount: number;
-    }) => Promise<boolean>;
+    delete: (arg: import("./topic/delete-topic.command.js").DeleteTopic) => Promise<boolean>;
     purge: (arg: import("./topic/purge-topic.command.js").PurgeTopic) => Promise<boolean>;
     ensure: (streamId: import("./identifier.utils.js").Id, topicName: string, partitionCount?: number, compressionAlgorithm?: number) => Promise<import("./topic/topic.utils.js").Topic>;
 };

package/dist/wire/command.utils.d.ts

@@ -17,10 +17,28 @@
  * under the License.
  */
 import type { CommandResponse, ClientProvider } from '../client/client.type.js';
+/**
+ * Represents a command that can be sent to the Iggy server.
+ *
+ * @typeParam I - Input type for the command arguments
+ * @typeParam O - Output type for the command response
+ */
 export type Command<I, O> = {
+    /** Command code identifying the operation */
     code: number;
+    /** Function to serialize command arguments to a Buffer */
     serialize: (args: I) => Buffer;
+    /** Function to deserialize the server response */
     deserialize: (r: CommandResponse) => O;
 };
+/**
+ * Wraps a command definition into an executable function.
+ * Creates a function that handles serialization, sending, and deserialization.
+ *
+ * @typeParam I - Input type for the command arguments
+ * @typeParam O - Output type for the command response
+ * @param cmd - Command definition with code, serialize, and deserialize functions
+ * @returns A function that takes a ClientProvider and returns an async command executor
+ */
 export declare function wrapCommand<I, O>(cmd: Command<I, O>): (getClient: ClientProvider) => (arg: I) => Promise<O>;
 //# sourceMappingURL=command.utils.d.ts.map

package/dist/wire/command.utils.js

@@ -16,6 +16,15 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Wraps a command definition into an executable function.
+ * Creates a function that handles serialization, sending, and deserialization.
+ *
+ * @typeParam I - Input type for the command arguments
+ * @typeParam O - Output type for the command response
+ * @param cmd - Command definition with code, serialize, and deserialize functions
+ * @returns A function that takes a ClientProvider and returns an async command executor
+ */
 export function wrapCommand(cmd) {
     return (getClient) => async (arg) => cmd.deserialize(await (await getClient()).sendCommand(cmd.code, cmd.serialize(arg)));
 }

package/dist/wire/consumer-group/create-group.command.d.ts

@@ -19,15 +19,28 @@
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Id } from '../identifier.utils.js';
 import { type ConsumerGroup } from './group.utils.js';
+/**
+ * Parameters for the create consumer group command.
+ */
 export type CreateGroup = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer group name (1-255 bytes) */
     name: string;
 };
+/**
+ * Create consumer group command definition.
+ * Creates a new consumer group within a topic.
+ */
 export declare const CREATE_GROUP: {
     code: number;
     serialize: ({ streamId, topicId, name }: CreateGroup) => Buffer<ArrayBuffer>;
     deserialize: (r: CommandResponse) => ConsumerGroup;
 };
+/**
+ * Executable create consumer group command function.
+ */
 export declare const createGroup: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: CreateGroup) => Promise<ConsumerGroup>;
 //# sourceMappingURL=create-group.command.d.ts.map

package/dist/wire/consumer-group/create-group.command.js

@@ -20,6 +20,10 @@ import { serializeIdentifier } from '../identifier.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { deserializeConsumerGroup } from './group.utils.js';
+/**
+ * Create consumer group command definition.
+ * Creates a new consumer group within a topic.
+ */
 export const CREATE_GROUP = {
     code: COMMAND_CODE.CreateGroup,
     serialize: ({ streamId, topicId, name }) => {
@@ -40,5 +44,8 @@ export const CREATE_GROUP = {
         return deserializeConsumerGroup(r.data).data;
     }
 };
+/**
+ * Executable create consumer group command function.
+ */
 export const createGroup = wrapCommand(CREATE_GROUP);
 //# sourceMappingURL=create-group.command.js.map

package/dist/wire/consumer-group/delete-group.command.d.ts

@@ -17,15 +17,28 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the delete consumer group command.
+ */
 export type DeleteGroup = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer group identifier (ID or name) */
     groupId: Id;
 };
+/**
+ * Delete consumer group command definition.
+ * Removes a consumer group from a topic.
+ */
 export declare const DELETE_GROUP: {
     code: number;
     serialize: ({ streamId, topicId, groupId }: DeleteGroup) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable delete consumer group command function.
+ */
 export declare const deleteGroup: (getClient: import("../../index.js").ClientProvider) => (arg: DeleteGroup) => Promise<boolean>;
 //# sourceMappingURL=delete-group.command.d.ts.map

package/dist/wire/consumer-group/delete-group.command.js

@@ -20,6 +20,10 @@ import { serializeTargetGroup } from './group.utils.js';
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Delete consumer group command definition.
+ * Removes a consumer group from a topic.
+ */
 export const DELETE_GROUP = {
     code: COMMAND_CODE.DeleteGroup,
     serialize: ({ streamId, topicId, groupId }) => {
@@ -27,5 +31,8 @@ export const DELETE_GROUP = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable delete consumer group command function.
+ */
 export const deleteGroup = wrapCommand(DELETE_GROUP);
 //# sourceMappingURL=delete-group.command.js.map

package/dist/wire/consumer-group/ensure-group.virtual.command.d.ts

@@ -17,7 +17,21 @@
  * under the License.
  */
 import type { Id } from '../identifier.utils.js';
-import { ClientProvider } from '../../client/index.js';
+import type { ClientProvider } from '../../client/index.js';
+/**
+ * Creates a virtual command that ensures a consumer group exists.
+ * If the group does not exist, it will be created.
+ *
+ * @param c - Client provider function
+ * @returns Function that ensures a consumer group exists by name
+ */
 export declare const ensureConsumerGroup: (c: ClientProvider) => (streamId: Id, topicId: Id, groupName: string) => Promise<import("./group.utils.js").ConsumerGroup>;
+/**
+ * Creates a virtual command that ensures a consumer group exists and joins it.
+ * If the group does not exist, it will be created, then the client joins the group.
+ *
+ * @param c - Client provider function
+ * @returns Function that ensures a consumer group exists and joins it
+ */
 export declare const ensureConsumerGroupAndJoin: (c: ClientProvider) => (streamId: Id, topicId: Id, groupName: string) => Promise<import("./group.utils.js").ConsumerGroup>;
 //# sourceMappingURL=ensure-group.virtual.command.d.ts.map

package/dist/wire/consumer-group/ensure-group.virtual.command.js

@@ -19,12 +19,26 @@
 import { createGroup } from './create-group.command.js';
 import { getGroup } from './get-group.command.js';
 import { joinGroup } from './join-group.command.js';
+/**
+ * Creates a virtual command that ensures a consumer group exists.
+ * If the group does not exist, it will be created.
+ *
+ * @param c - Client provider function
+ * @returns Function that ensures a consumer group exists by name
+ */
 export const ensureConsumerGroup = (c) => async function ensureConsumerGroup(streamId, topicId, groupName) {
     const group = await getGroup(c)({ streamId, topicId, groupId: groupName });
     if (!group)
         return await createGroup(c)({ streamId, topicId, name: groupName });
     return group;
 };
+/**
+ * Creates a virtual command that ensures a consumer group exists and joins it.
+ * If the group does not exist, it will be created, then the client joins the group.
+ *
+ * @param c - Client provider function
+ * @returns Function that ensures a consumer group exists and joins it
+ */
 export const ensureConsumerGroupAndJoin = (c) => async function ensureConsumerGroupAndJoin(streamId, topicId, groupName) {
     const group = await ensureConsumerGroup(c)(streamId, topicId, groupName);
     await joinGroup(c)({ streamId, topicId, groupId: group.id });

package/dist/wire/consumer-group/get-group.command.d.ts

@@ -19,15 +19,28 @@
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Id } from '../identifier.utils.js';
 import { type ConsumerGroup } from './group.utils.js';
+/**
+ * Parameters for the get consumer group command.
+ */
 export type GetGroup = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer group identifier (ID or name) */
     groupId: Id;
 };
+/**
+ * Get consumer group command definition.
+ * Retrieves information about a specific consumer group.
+ */
 export declare const GET_GROUP: {
     code: number;
     serialize: ({ streamId, topicId, groupId }: GetGroup) => Buffer<ArrayBuffer>;
     deserialize: (r: CommandResponse) => ConsumerGroup | null;
 };
+/**
+ * Executable get consumer group command function.
+ */
 export declare const getGroup: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: GetGroup) => Promise<ConsumerGroup | null>;
 //# sourceMappingURL=get-group.command.d.ts.map

package/dist/wire/consumer-group/get-group.command.js

@@ -19,6 +19,10 @@
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
 import { serializeTargetGroup, deserializeConsumerGroup } from './group.utils.js';
+/**
+ * Get consumer group command definition.
+ * Retrieves information about a specific consumer group.
+ */
 export const GET_GROUP = {
     code: COMMAND_CODE.GetGroup,
     serialize: ({ streamId, topicId, groupId }) => {
@@ -30,5 +34,8 @@ export const GET_GROUP = {
         return deserializeConsumerGroup(r.data).data;
     }
 };
+/**
+ * Executable get consumer group command function.
+ */
 export const getGroup = wrapCommand(GET_GROUP);
 //# sourceMappingURL=get-group.command.js.map

package/dist/wire/consumer-group/get-groups.command.d.ts

@@ -19,14 +19,26 @@
 import type { CommandResponse } from '../../client/client.type.js';
 import type { ConsumerGroup } from './group.utils.js';
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the get consumer groups command.
+ */
 export type GetGroups = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
 };
+/**
+ * Get consumer groups command definition.
+ * Retrieves all consumer groups within a topic.
+ */
 export declare const GET_GROUPS: {
     code: number;
     serialize: ({ streamId, topicId }: GetGroups) => Buffer<ArrayBuffer>;
     deserialize: (r: CommandResponse) => ConsumerGroup[];
 };
+/**
+ * Executable get consumer groups command function.
+ */
 export declare const getGroups: (getClient: import("../../client/client.type.js").ClientProvider) => (arg: GetGroups) => Promise<ConsumerGroup[]>;
 //# sourceMappingURL=get-groups.command.d.ts.map

package/dist/wire/consumer-group/get-groups.command.js

@@ -20,6 +20,10 @@ import { serializeIdentifier } from '../identifier.utils.js';
 import { deserializeConsumerGroups } from './group.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Get consumer groups command definition.
+ * Retrieves all consumer groups within a topic.
+ */
 export const GET_GROUPS = {
     code: COMMAND_CODE.GetGroups,
     serialize: ({ streamId, topicId }) => {
@@ -32,5 +36,8 @@ export const GET_GROUPS = {
         return deserializeConsumerGroups(r.data);
     }
 };
+/**
+ * Executable get consumer groups command function.
+ */
 export const getGroups = wrapCommand(GET_GROUPS);
 //# sourceMappingURL=get-groups.command.js.map

package/dist/wire/consumer-group/group.utils.d.ts

@@ -17,18 +17,52 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Consumer group information.
+ */
 export type ConsumerGroup = {
+    /** Consumer group ID */
     id: number;
+    /** Consumer group name */
     name: string;
+    /** Number of members in the group */
     membersCount: number;
+    /** Number of partitions assigned to the group */
     partitionsCount: number;
 };
+/**
+ * Result of deserializing a consumer group.
+ */
 type ConsumerGroupDeserialized = {
+    /** Number of bytes consumed */
     bytesRead: number;
+    /** Deserialized consumer group data */
     data: ConsumerGroup;
 };
+/**
+ * Serializes stream, topic, and group identifiers for targeting a consumer group.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param groupId - Consumer group identifier (ID or name)
+ * @returns Buffer containing serialized identifiers
+ */
 export declare const serializeTargetGroup: (streamId: Id, topicId: Id, groupId: Id) => Buffer<ArrayBuffer>;
+/**
+ * Deserializes a consumer group from a buffer.
+ *
+ * @param r - Buffer containing serialized consumer group data
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and deserialized consumer group data
+ */
 export declare const deserializeConsumerGroup: (r: Buffer, pos?: number) => ConsumerGroupDeserialized;
+/**
+ * Deserializes multiple consumer groups from a buffer.
+ *
+ * @param r - Buffer containing serialized consumer groups data
+ * @param pos - Starting position in the buffer
+ * @returns Array of deserialized consumer groups
+ */
 export declare const deserializeConsumerGroups: (r: Buffer, pos?: number) => ConsumerGroup[];
 export {};
 //# sourceMappingURL=group.utils.d.ts.map

package/dist/wire/consumer-group/group.utils.js

@@ -17,6 +17,14 @@
  * under the License.
  */
 import { serializeIdentifier } from '../identifier.utils.js';
+/**
+ * Serializes stream, topic, and group identifiers for targeting a consumer group.
+ *
+ * @param streamId - Stream identifier (ID or name)
+ * @param topicId - Topic identifier (ID or name)
+ * @param groupId - Consumer group identifier (ID or name)
+ * @returns Buffer containing serialized identifiers
+ */
 export const serializeTargetGroup = (streamId, topicId, groupId) => {
     return Buffer.concat([
         serializeIdentifier(streamId),
@@ -24,6 +32,13 @@ export const serializeTargetGroup = (streamId, topicId, groupId) => {
         serializeIdentifier(groupId)
     ]);
 };
+/**
+ * Deserializes a consumer group from a buffer.
+ *
+ * @param r - Buffer containing serialized consumer group data
+ * @param pos - Starting position in the buffer
+ * @returns Object with bytes read and deserialized consumer group data
+ */
 export const deserializeConsumerGroup = (r, pos = 0) => {
     const id = r.readUInt32LE(pos);
     const partitionsCount = r.readUInt32LE(pos + 4);
@@ -40,6 +55,13 @@ export const deserializeConsumerGroup = (r, pos = 0) => {
         }
     };
 };
+/**
+ * Deserializes multiple consumer groups from a buffer.
+ *
+ * @param r - Buffer containing serialized consumer groups data
+ * @param pos - Starting position in the buffer
+ * @returns Array of deserialized consumer groups
+ */
 export const deserializeConsumerGroups = (r, pos = 0) => {
     const end = r.length;
     const cgroups = [];

package/dist/wire/consumer-group/join-group.command.d.ts

@@ -17,15 +17,28 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the join consumer group command.
+ */
 export type JoinGroup = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer group identifier (ID or name) */
     groupId: Id;
 };
+/**
+ * Join consumer group command definition.
+ * Adds the current client as a member of the consumer group.
+ */
 export declare const JOIN_GROUP: {
     code: number;
     serialize: ({ streamId, topicId, groupId }: JoinGroup) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable join consumer group command function.
+ */
 export declare const joinGroup: (getClient: import("../../index.js").ClientProvider) => (arg: JoinGroup) => Promise<boolean>;
 //# sourceMappingURL=join-group.command.d.ts.map

package/dist/wire/consumer-group/join-group.command.js

@@ -20,6 +20,10 @@ import { serializeTargetGroup } from './group.utils.js';
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Join consumer group command definition.
+ * Adds the current client as a member of the consumer group.
+ */
 export const JOIN_GROUP = {
     code: COMMAND_CODE.JoinGroup,
     serialize: ({ streamId, topicId, groupId }) => {
@@ -27,5 +31,8 @@ export const JOIN_GROUP = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable join consumer group command function.
+ */
 export const joinGroup = wrapCommand(JOIN_GROUP);
 //# sourceMappingURL=join-group.command.js.map

package/dist/wire/consumer-group/leave-group.command.d.ts

@@ -17,15 +17,28 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the leave consumer group command.
+ */
 export type LeaveGroup = {
+    /** Stream identifier (ID or name) */
     streamId: Id;
+    /** Topic identifier (ID or name) */
     topicId: Id;
+    /** Consumer group identifier (ID or name) */
     groupId: Id;
 };
+/**
+ * Leave consumer group command definition.
+ * Removes the current client from the consumer group.
+ */
 export declare const LEAVE_GROUP: {
     code: number;
     serialize: ({ streamId, topicId, groupId }: LeaveGroup) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable leave consumer group command function.
+ */
 export declare const leaveGroup: (getClient: import("../../index.js").ClientProvider) => (arg: LeaveGroup) => Promise<boolean>;
 //# sourceMappingURL=leave-group.command.d.ts.map

package/dist/wire/consumer-group/leave-group.command.js

@@ -20,6 +20,10 @@ import { serializeTargetGroup } from './group.utils.js';
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Leave consumer group command definition.
+ * Removes the current client from the consumer group.
+ */
 export const LEAVE_GROUP = {
     code: COMMAND_CODE.LeaveGroup,
     serialize: ({ streamId, topicId, groupId }) => {
@@ -27,5 +31,8 @@ export const LEAVE_GROUP = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable leave consumer group command function.
+ */
 export const leaveGroup = wrapCommand(LEAVE_GROUP);
 //# sourceMappingURL=leave-group.command.js.map

package/dist/wire/identifier.utils.d.ts

@@ -16,6 +16,17 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/**
+ * Identifier type that can be either a numeric ID or a string name.
+ * Used to identify streams, topics, partitions, and other resources.
+ */
 export type Id = number | string;
+/**
+ * Serializes an identifier (numeric or string) to a Buffer for wire protocol.
+ *
+ * @param id - Numeric ID or string name to serialize
+ * @returns Buffer containing the serialized identifier
+ * @throws Error if the identifier type is not supported
+ */
 export declare const serializeIdentifier: (id: Id) => Buffer;
 //# sourceMappingURL=identifier.utils.d.ts.map

package/dist/wire/identifier.utils.js

@@ -16,8 +16,17 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+/** Identifier kind for numeric IDs */
 const NUMERIC = 1;
+/** Identifier kind for string IDs */
 const STRING = 2;
+/**
+ * Serializes an identifier (numeric or string) to a Buffer for wire protocol.
+ *
+ * @param id - Numeric ID or string name to serialize
+ * @returns Buffer containing the serialized identifier
+ * @throws Error if the identifier type is not supported
+ */
 export const serializeIdentifier = (id) => {
     if ('string' === typeof id) {
         return serializeStringId(id);
@@ -25,8 +34,15 @@ export const serializeIdentifier = (id) => {
     if ('number' === typeof id) {
         return serializeNumericId(id);
     }
-    throw new Error(`Unsuported id type (${id} - ${typeof id})`);
+    throw new Error(`Unsupported id type (${id} - ${typeof id})`);
 };
+/**
+ * Serializes a string identifier to a Buffer.
+ *
+ * @param id - String name to serialize (1-255 bytes)
+ * @returns Buffer containing kind, length, and string bytes
+ * @throws Error if the string length is not between 1 and 255 bytes
+ */
 const serializeStringId = (id) => {
     const b = Buffer.alloc(1 + 1);
     const bId = Buffer.from(id);
@@ -39,6 +55,12 @@ const serializeStringId = (id) => {
         bId
     ]);
 };
+/**
+ * Serializes a numeric identifier to a Buffer.
+ *
+ * @param id - Numeric ID to serialize (32-bit unsigned integer)
+ * @returns Buffer containing kind, length, and ID bytes in little-endian format
+ */
 const serializeNumericId = (id) => {
     const b = Buffer.alloc(1 + 1 + 4);
     b.writeUInt8(NUMERIC);

package/dist/wire/message/flush-unsaved-buffers.command.d.ts

@@ -17,15 +17,28 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
+/**
+ * Parameters for the flush unsaved buffers command.
+ */
 export type FlushUnsavedBuffer = {
+    /** Stream identifier */
     streamId: Id;
+    /** Topic identifier */
     topicId: Id;
+    /** Partition ID to flush */
     partitionId: number;
 };
+/**
+ * Flush unsaved buffers command definition.
+ * Forces buffered messages to be persisted to disk.
+ */
 export declare const FLUSH_UNSAVED_BUFFERS: {
     code: number;
     serialize: ({ streamId, topicId, partitionId }: FlushUnsavedBuffer) => Buffer<ArrayBuffer>;
     deserialize: (r: import("../../index.js").CommandResponse) => boolean;
 };
+/**
+ * Executable flush unsaved buffers command function.
+ */
 export declare const flushUnsavedBuffers: (getClient: import("../../index.js").ClientProvider) => (arg: FlushUnsavedBuffer) => Promise<boolean>;
 //# sourceMappingURL=flush-unsaved-buffers.command.d.ts.map

package/dist/wire/message/flush-unsaved-buffers.command.js

@@ -20,6 +20,10 @@ import { serializeFlushUnsavedBuffers } from './message.utils.js';
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
+/**
+ * Flush unsaved buffers command definition.
+ * Forces buffered messages to be persisted to disk.
+ */
 export const FLUSH_UNSAVED_BUFFERS = {
     code: COMMAND_CODE.FlushUnsavedBuffers,
     serialize: ({ streamId, topicId, partitionId }) => {
@@ -27,5 +31,8 @@ export const FLUSH_UNSAVED_BUFFERS = {
     },
     deserialize: deserializeVoidResponse
 };
+/**
+ * Executable flush unsaved buffers command function.
+ */
 export const flushUnsavedBuffers = wrapCommand(FLUSH_UNSAVED_BUFFERS);
 //# sourceMappingURL=flush-unsaved-buffers.command.js.map