@karmaniverous/entity-manager 7.3.2 → 7.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +10 -10
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -382,11 +382,11 @@ interface QueryOptions<CC extends BaseConfigMap, ET extends EntityToken<CC> = En
|
|
|
382
382
|
* number of shards queried, unless limited by available records in a given
|
|
383
383
|
* shard.
|
|
384
384
|
*/
|
|
385
|
-
limit?: number;
|
|
385
|
+
limit?: number | undefined;
|
|
386
386
|
/**
|
|
387
387
|
* {@link QueryResult.pageKeyMap | `pageKeyMap`} returned by the previous iteration of this query.
|
|
388
388
|
*/
|
|
389
|
-
pageKeyMap?: string;
|
|
389
|
+
pageKeyMap?: string | undefined;
|
|
390
390
|
/**
|
|
391
391
|
* The maximum number of records to be returned by each individual query to a
|
|
392
392
|
* single shard (i.e. {@link ShardQueryFunction | `ShardQueryFunction`} execution).
|
|
@@ -395,7 +395,7 @@ interface QueryOptions<CC extends BaseConfigMap, ET extends EntityToken<CC> = En
|
|
|
395
395
|
* repeated until either available data is exhausted or the {@link QueryOptions.limit | `limit`} value is
|
|
396
396
|
* reached.
|
|
397
397
|
*/
|
|
398
|
-
pageSize?: number;
|
|
398
|
+
pageSize?: number | undefined;
|
|
399
399
|
/**
|
|
400
400
|
* Each key in this object is a valid entity index token. Each value is a valid
|
|
401
401
|
* {@link ShardQueryFunction | 'ShardQueryFunction'} that specifies the query of a single page of data on a
|
|
@@ -409,7 +409,7 @@ interface QueryOptions<CC extends BaseConfigMap, ET extends EntityToken<CC> = En
|
|
|
409
409
|
/**
|
|
410
410
|
* A {@link SortOrder | `SortOrder`} object specifying the sort order of the result set. Defaults to `[]`. Aligned with the projected item shape when K is provided.
|
|
411
411
|
*/
|
|
412
|
-
sortOrder?: SortOrder<ProjectedItemByToken<CC, ET, K
|
|
412
|
+
sortOrder?: SortOrder<ProjectedItemByToken<CC, ET, K>> | undefined;
|
|
413
413
|
/**
|
|
414
414
|
* Lower limit to query shard space.
|
|
415
415
|
*
|
|
@@ -419,7 +419,7 @@ interface QueryOptions<CC extends BaseConfigMap, ET extends EntityToken<CC> = En
|
|
|
419
419
|
*
|
|
420
420
|
* @defaultValue `0`
|
|
421
421
|
*/
|
|
422
|
-
timestampFrom?: number;
|
|
422
|
+
timestampFrom?: number | undefined;
|
|
423
423
|
/**
|
|
424
424
|
* Upper limit to query shard space.
|
|
425
425
|
*
|
|
@@ -429,13 +429,13 @@ interface QueryOptions<CC extends BaseConfigMap, ET extends EntityToken<CC> = En
|
|
|
429
429
|
*
|
|
430
430
|
* @defaultValue `Date.now()`
|
|
431
431
|
*/
|
|
432
|
-
timestampTo?: number;
|
|
432
|
+
timestampTo?: number | undefined;
|
|
433
433
|
/**
|
|
434
434
|
* The maximum number of shards to query in parallel. Overrides options `throttle`.
|
|
435
435
|
*
|
|
436
436
|
* @defaultValue `options.throttle`
|
|
437
437
|
*/
|
|
438
|
-
throttle?: number;
|
|
438
|
+
throttle?: number | undefined;
|
|
439
439
|
}
|
|
440
440
|
/**
|
|
441
441
|
* Convenience alias for QueryOptions that derives ITS (index token subset)
|
|
@@ -747,7 +747,7 @@ interface BaseEntityClientOptions<CC extends BaseConfigMap, CF = unknown> {
|
|
|
747
747
|
/** {@link EntityManager | `EntityManager`} instance. */
|
|
748
748
|
entityManager: EntityManager<CC, CF>;
|
|
749
749
|
/** Injected logger object. Must support `debug` and `error` methods. Default: `console` */
|
|
750
|
-
logger?: Pick<Console, 'debug' | 'error'
|
|
750
|
+
logger?: Pick<Console, 'debug' | 'error'> | undefined;
|
|
751
751
|
}
|
|
752
752
|
|
|
753
753
|
/**
|
|
@@ -796,7 +796,7 @@ interface BaseQueryBuilderOptions<CC extends BaseConfigMap, EntityClient extends
|
|
|
796
796
|
/** Hash key token. */
|
|
797
797
|
hashKeyToken: CC['HashKey'] | CC['ShardedKeys'];
|
|
798
798
|
/** Dehydrated page key map. */
|
|
799
|
-
pageKeyMap?: string;
|
|
799
|
+
pageKeyMap?: string | undefined;
|
|
800
800
|
}
|
|
801
801
|
|
|
802
802
|
/**
|
|
@@ -830,7 +830,7 @@ declare abstract class BaseQueryBuilder<CC extends BaseConfigMap, EntityClient e
|
|
|
830
830
|
/** Hash key token. */
|
|
831
831
|
readonly hashKeyToken: CC['HashKey'] | CC['ShardedKeys'];
|
|
832
832
|
/** Dehydrated page key map. */
|
|
833
|
-
readonly pageKeyMap?: string;
|
|
833
|
+
readonly pageKeyMap?: string | undefined;
|
|
834
834
|
/**
|
|
835
835
|
* Maps `indexToken` values to database platform-specific query parameters.
|
|
836
836
|
*
|
package/package.json
CHANGED