Type Alias DataItemDBDriverConfig<ItemType, UniquelyIdentifyingFieldName>

The generic type for a database driver configuration.

type DataItemDBDriverConfig<
    ItemType extends TypeInfoDataItem,
    UniquelyIdentifyingFieldName extends keyof ItemType,
> = {
    dbSpecificConfig?: Record<string, any>;
    generateUniqueIdentifier?: (targetItem: ItemType) => string;
    tableName: string;
    uniquelyIdentifyingFieldName: UniquelyIdentifyingFieldName;
}

Type Parameters

ItemType extends TypeInfoDataItem
UniquelyIdentifyingFieldName extends keyof ItemType

Index

Properties

dbSpecificConfig? generateUniqueIdentifier? tableName uniquelyIdentifyingFieldName

Properties

`Optional`dbSpecificConfig

dbSpecificConfig?: Record<string, any>

Optional DB-specific configuration payload.

`Optional`generateUniqueIdentifier

generateUniqueIdentifier?: (targetItem: ItemType) => string

Optional identifier generator for new items.

tableName

tableName: string

Backing table or collection name.

uniquelyIdentifyingFieldName

uniquelyIdentifyingFieldName: UniquelyIdentifyingFieldName

Field name used as the unique identifier.