Interface Database

interface Database {
    collection(name: string): Collection | null;
    createCollection(name: string): Collection;
    flush(): Promise<void>;
    init(): Promise<void>;
    removeCollection(name: string): void;
}

Index

Methods

collection createCollection flush init removeCollection

Methods

collection

collection(name: string): Collection | null
Parameters
- name: string
Returns Collection | null
returns null if the collection does not exist
Throws
- DatabaseNotInitializedError: When the database is not initialized
- Defined in src/types/database.ts:59

createCollection

createCollection(name: string): Collection
Parameters
- name: string
Returns Collection
Throws
- DatabaseNotInitializedError: When the database is not initialized
- CollectionAlreadyExistsError: When the collection already exists
- Defined in src/types/database.ts:44

flush

flush(): Promise<void>
Waits for all pending writes to complete and reports any accumulated errors.

Returns Promise<void>
Remarks
- Resolves only after all scheduled writes have finished.
- If any write errors occurred, they are aggregated and thrown as an AggregateError.
- After throwing, the internal error state is cleared and the database is marked as uninitialized.
Throws
If one or more write operations failed.
- Defined in src/types/database.ts:37

init

init(): Promise<void>
Should be called before any operation on the database.

Returns Promise<void>
- Defined in src/types/database.ts:25

removeCollection

removeCollection(name: string): void
Parameters
- name: string
Returns void
Throws
- DatabaseNotInitializedError: When the database is not initialized
- CollectionNotExistsError: When the collection does not exist
- Defined in src/types/database.ts:51