Property function to determine if the name is a reserved word and should use an alias. For a current list of reserved words see DynamoDB-ReservedWords module in NPM. The reason to set isReservedName and isValidName is to allow the attribute names to be directly embedded into the expression string, which can make them easier to read.
Property function to determine if the name is valid to use without an alias. Can use ExpressionAttribute.isValidAttributeName. WARNING: Must be used with a proper isReservedName function to ensure reserved words are not used without an alias otherwise the operations will return an error.
Attribute names mapping, used to populate the ExpressionAttributeNames param.
Auto incrementing name id used in names mapping.
Auto incrementing value id used in values mapping.
Delimiter to use for paths.
Parse all names into paths by using the pathDelimiter, to make working with nested attributes easy.
Attribute values mapping, used to populate the ExpressionAttributeValues param.
RegEx that validates an attribute name would not need to use an alias.
Parse an attribute path and adds the names to the names mapping as needed and hands back an alias to use in an expression. If the name already exists in the map the existing alias will be used. When this.treatNameAsPath is true the name argument will be parsed as a path and will handle arrays embedded in the path correctly, to allow access to all deep attribute.
Attribute path that can be delimited by a pathDelimiter and contain array notations '[]'.
Alias path to use for the attribute name or the name if not aliasing is needed, delimited by '.'.
Adds the value to the values map and hands back an alias to use in ab expression. A new alias will always be created every time addValue is called.
Value to add to the values map.
Alias to use in place of the value.
Gets the names map to assign to ExpressionAttributeNames.
The map of all names added.
Gets the values map to assign to ExpressionAttributeValues.
The map of all values added.
Helper method to set ExpressionAttributeNames and ExpressionAttributeValues values on the input argument.
Input params used for DocumentClient put, delete, update, query and scan methods.
The input params argument passed in.
Validates that an attribute name can be used without an alias.
Name of an attribute.
true if the attribute name is valid.
Generated using TypeDoc
Object used in Condition, KeyCondition and Update resolver methods to create attribute names and values aliases and store the mappings for use in ExpressionAttributeNames and ExpressionAttributeValues params.