DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/type-aliases/StringCollationConfig.md
StringCollationConfig
ts
type StringCollationConfig =
| {
stringSort?: "lexical";
}
| {
locale?: string;
localeOptions?: object;
stringSort?: "locale";
}
| {
compare: (a, b) => number;
stringSort: "custom";
};Defined in: packages/db/src/types.ts:34
StringCollationConfig - Options for string sorting behavior
This discriminated union allows for three types of string sorting:
- Lexical: Simple character-by-character comparison
- Locale: Locale-aware sorting with optional customization
- Custom: Local comparison by a stable user-provided function reference
Custom comparators must remain deterministic and immutable for their lifetime. Runtime query and index identity uses the exact function reference.