Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Type aliases

Binary: BinaryValue | Update.Resolver<"B">

Binary specific update resolver, used to define properties in Model interfaces.

BinarySet: BinaryValue[] | BinarySetValue | Update.Resolver<"BS">

Binary Set specific update resolver, used to define properties in Model interfaces.

Boolean: boolean | Update.Resolver<"BOOL">

Boolean specific update resolver, used to define properties in Model interfaces.

List<T>: Update.ModelT<T>[] | Update.Resolver<"L">

List specific update resolver, used to define properties in Model interfaces.

Type parameters

Map<T>: {} | Update.Resolver<"M">

Map specific update resolver, used to define properties in Model interfaces.

Type parameters

Model<T>: Update.ModelT<T> | Update.Resolver<"M">

Map specific update resolver, used to define properties in Model interfaces.

Type parameters

  • T

    The model interface.

ModelList<T>: Update.ModelT<T>[] | Update.Resolver<"L">

List specific update resolver, used to define properties in Model interfaces.

Type parameters

  • T

    The model interface.

ModelMap<T>: {} | Update.Resolver<"M">

Map specific update resolver, used to define properties in Model interfaces.

Type parameters

  • T

    The model interface.

ModelT<T>: { [ P in keyof T]: Exclude<T[P], Function> }

Wrapper to remove recursive types so model interface properties get output with correct type.

Type parameters

  • T

Null: null | Update.Resolver<"NULL">

Null specific update resolver, used to define properties in Model interfaces.

Number: number | Update.Resolver<"N">

Number specific update resolver, used to define properties in Model interfaces.

NumberSet: number[] | NumberSetValue | Update.Resolver<"NS">

Number Set specific update resolver, used to define properties in Model interfaces.

OperandFunction: (name: string, exp: Update.Expression) => string

Type declaration

    • Update function return by path and pathWithDefault to support nested resolvers.

      Parameters

      • name: string

        Name of the item attribute to resolve.

      • exp: Update.Expression

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

      Returns string

      The resolved value of the update function.

OperandList<T>: OperandValue<string | T[]>

Type used for generic list based update methods.

Type parameters

OperandNumber: OperandValue<string | number>

Type used for number based update methods.

OperandValue<T>: T | OperandFunction

Type used for general update methods

Type parameters

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

Type parameters

  • T

    The type used for the value param.

Type declaration

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

      Parameters

      • name: string

        Name of the item attribute to resolve.

      • exp: Update.Expression

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

      • Optional type: T

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

      Returns void

Type used for map based update methods.

ResolverMapT<T>: {}

Type used for generic map based update methods.

Type parameters

  • T

    The model interface.

Type declaration

ResolverModel<T>: { [ P in keyof Optional<T>]: ResolverModelValue<T[P]> }

Resolver for the overall Model.

Type parameters

  • T

    The model interface.

ResolverModelMap<T>: {}

Resolver for the map with string keys and Model values.

Type parameters

  • T

    The model interface.

Type declaration

ResolverModelValue<T>: Extract<T, Table.AttributeValues | Update.Resolver<Table.AttributeTypes>> | null

Resolver for each property of the model

Type parameters

  • T

    The model interface.

String: string | Update.Resolver<"S">

String specific update resolver, used to define properties in Model interfaces.

StringSet: string[] | StringSetValue | Update.Resolver<"SS">

String Set specific update resolver, used to define properties in Model interfaces.

Generated using TypeDoc