Interface MetaStorage

Storage contract for persistent term/vote state.

interface MetaStorage {
    close(): Promise<void>;
    isOpen(): boolean;
    open(): Promise<void>;
    read(): Promise<MetaData | null>;
    write(term: number, votedFor: string | null): Promise<void>;
}

Index

Methods

close isOpen open read write

Methods

close

close(): Promise<void>
Closes storage resources.

Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/MetaStorage.ts:20

isOpen

isOpen(): boolean
Returns true when storage is open.

Returns boolean
- Defined in packages/raft-core/src/storage/interfaces/MetaStorage.ts:22

open

open(): Promise<void>
Opens storage resources.

Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/MetaStorage.ts:18

read

read(): Promise<MetaData | null>
Reads durable term/vote state, or null when uninitialized.

Returns Promise<MetaData | null>
- Defined in packages/raft-core/src/storage/interfaces/MetaStorage.ts:25

write

write(term: number, votedFor: string | null): Promise<void>
Persists term and vote atomically.
Parameters
- term: number
- votedFor: string | null
Returns Promise<void>
- Defined in packages/raft-core/src/storage/interfaces/MetaStorage.ts:28