Skip to content

Commit

Permalink
Update index.md (#622)
Browse files Browse the repository at this point in the history
Make readme consistent
  • Loading branch information
Geert authored Nov 3, 2023
1 parent 37b4fc3 commit e527a1a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/entity/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ For more control over an attribute's behavior, you can specify an object as the
| prefix | `string` | `string` | A prefix to be added to an attribute when saved to DynamoDB. This prefix will be removed when parsing the data. |
| suffix | `string` | `string` | A suffix to be added to an attribute when saved to DynamoDB. This suffix will be removed when parsing the data. |
| transform | `function` | all | A function that transforms the input before sending to DynamoDB. This accepts two arguments, the value passed and an object containing the data from other attributes. |
| format | `function` | all | A function that transforms the DDB output before sending it to the parser. This accepts two arguments, the value of the attribute and an object containing the whole item. |
| format | `function` | all | A function that transforms the DynamoDB output before sending it to the parser. This accepts two arguments, the value of the attribute and an object containing the whole item. |
| partitionKey | `boolean` or `string` | all | Flags an attribute as the 'partitionKey' for this Entity. If set to `true`, it will be mapped to the Table's `partitionKey`. If set to the name of an **index** defined on the Table, it will be mapped to the secondary index's `partitionKey` |
| sortKey | `boolean` or `string` | all | Flags an attribute as the 'sortKey' for this Entity. If set to `true`, it will be mapped to the Table's `sortKey`. If set to the name of an **index** defined on the Table, it will be mapped to the secondary index's `sortKey` |

Expand Down

0 comments on commit e527a1a

Please sign in to comment.