Options
All
  • Public
  • Public/Protected
  • All
Menu

Object passed down to KeyCondition.Resolver functions to support getting path and value aliases and provide context to the resolver function to support advanced key condition resolvers.

Hierarchy

  • KeyConditionExpression

Implements

Index

Constructors

Properties

Object for getting path and value aliases.

conditions: string[] = []

Array of conditions expressions. DynamoDB currently only supports two conditions that with an 'AND' between them.

Methods

  • addCondition(condition: string): void
  • addPath(path: string): string
  • getExpression(): string | void
  • Gets the expression from paths, values and conditions added.

    Returns string | void

    key condition expression to use KeyConditionExpression param.

  • Helper function to set a 'KeyConditionExpression' value on the params argument if there are conditions to resolve.

    Parameters

    • params: { KeyConditionExpression?: string }

      Params used for DocumentClient query methods.

      • Optional KeyConditionExpression?: string
    • attributes: Table.ExpressionAttributes
    • key: KeyQueryMap

      List of conditions to evaluate with AND.

    Returns void

    The params argument passed in.

  • Create a key condition expression from a primary key.

    Parameters

    • key: KeyQueryMap

      Primary key value to build the expression from.

    • exp: KeyCondition.Expression

      Object used to get path and value aliases and store the key conditions array.

    Returns string | void

    A key condition expression to use for the KeyConditionExpression param.

Generated using TypeDoc