Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 2.56 KB

index.md

File metadata and controls

80 lines (49 loc) · 2.56 KB

optimus-ddb-client

optimus-ddb-client

This is low level documentation. Please see README.md for the high level documentation.

Table of contents

Classes

Type Aliases

Type Aliases

FilterCondition

Ƭ FilterCondition<I>: { [K in keyof I]: FilterConditionLeaf<K, I[K]> }[keyof I] | [FilterCondition<I>, "or", FilterCondition<I>] | [FilterCondition<I>, "and", FilterCondition<I>] | [FilterCondition<I>]

Type representing a condition for filtering items during a query or scan.

Type parameters

Name Type
I extends Record<string, any>

Defined in

src/Types.ts:41


PartitionKeyCondition

Ƭ PartitionKeyCondition<L, R>: [L, "=", R]

Type representing a condition that specifies a partition.

Type parameters

Name
L
R

Defined in

src/Types.ts:12


SortKeyCondition

Ƭ SortKeyCondition<L, R>: R extends string ? [L, "=", R] | [L, "<" | ">" | "<=" | ">=" | "begins with", string] | [L, "between", string, "and", string] : R extends Uint8Array ? [L, "=", R] | [L, "<" | ">" | "<=" | ">=" | "begins with", Uint8Array] | [L, "between", Uint8Array, "and", Uint8Array] : [L, "=" | "<" | ">" | "<=" | ">=", R] | [L, "between", R, "and", R]

Type representing a condition that specifies how a partition is queried.

Type parameters

Name
L
R

Defined in

src/Types.ts:15