Options
All
  • Public
  • Public/Protected
  • All
Menu

Is also a namespace for scoping KeyCondition based interfaces and types.

Index

Type aliases

Support key condition resolvers.

BinaryResolver: KeyCondition.Resolver<"B">

Binary key condition resolver.

CompareOperators: "=" | "<" | "<=" | ">" | ">="

Supported compare based operators for conditions expressions.

NumberResolver: KeyCondition.Resolver<"N">

Number key condition resolver.

Operators: KeyCondition.CompareOperators | "BETWEEN" | "begins_with"

Support operators and functions for condition expressions.

Resolver<T>: (name: string, exp: KeyCondition.Expression, type?: T) => void

Type parameters

Type declaration

    • Resolver function is return by most of the above KeyConditions methods. Returning a function allows key conditions to easily be composable and extensible. This allows consumers to create higher level key conditions that are composed of the above primitive key conditions or support any new primitives that AWS would add in the future.

      Parameters

      • name: string

        Name of the primary key attribute to resolve.

      • exp: KeyCondition.Expression

        Object to get path and value aliases and store conditions array.

      • Optional type: T

        Param to enforce type safety for conditions that only work on certain types.

      Returns void

StringResolver: KeyCondition.Resolver<"S">

String key condition resolver.

Generated using TypeDoc