Skip to content

Commit bdeaa91

Browse files
committed
Update docstrings
1 parent a0c494e commit bdeaa91

File tree

2 files changed

+5
-22
lines changed

2 files changed

+5
-22
lines changed

packages/db/src/local-only.ts

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,9 @@ import type { StandardSchemaV1 } from "@standard-schema/spec"
1212

1313
/**
1414
* Configuration interface for Local-only collection options
15-
* @template TExplicit - The explicit type of items in the collection (highest priority)
16-
* @template TSchema - The schema type for validation and type inference (second priority)
17-
* @template TFallback - The fallback type if no explicit or schema type is provided
15+
* @template T - The type of items in the collection
16+
* @template TSchema - The schema type for validation
1817
* @template TKey - The type of the key returned by getKey
19-
*
20-
* @remarks
21-
* Type resolution follows a priority order:
22-
* 1. If you provide an explicit type via generic parameter, it will be used
23-
* 2. If no explicit type is provided but a schema is, the schema's output type will be inferred
24-
* 3. If neither explicit type nor schema is provided, the fallback type will be used
25-
*
26-
* You should provide EITHER an explicit type OR a schema, but not both, as they would conflict.
2718
*/
2819
export interface LocalOnlyCollectionConfig<
2920
T extends object = object,

packages/db/src/local-storage.ts

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,9 @@ interface StoredItem<T> {
4646

4747
/**
4848
* Configuration interface for localStorage collection options
49-
* @template T - The explicit type of items in the collection (highest priority)
50-
* @template TSchema - The schema type for validation and type inference (second priority)
51-
* @template TFallback - The fallback type if no explicit or schema type is provided
52-
*
53-
* @remarks
54-
* Type resolution follows a priority order:
55-
* 1. If you provide an explicit type via generic parameter, it will be used
56-
* 2. If no explicit type is provided but a schema is, the schema's output type will be inferred
57-
* 3. If neither explicit type nor schema is provided, the fallback type will be used
58-
*
59-
* You should provide EITHER an explicit type OR a schema, but not both, as they would conflict.
49+
* @template T - The type of items in the collection
50+
* @template TSchema - The schema type for validation
51+
* @template TKey - The type of the key returned by `getKey`
6052
*/
6153
export interface LocalStorageCollectionConfig<
6254
T extends object = object,

0 commit comments

Comments
 (0)