Skip to content

Commit 0cf1632

Browse files
committed
📝 doc
Signed-off-by: moznion <moznion@mail.moznion.net>
1 parent 3942ddc commit 0cf1632

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Code transformer plugin powered by [TypeScript Compiler API](https://github.com/
77
This plugin replaces the TypeScript function invocation with the generated object code. In short, this plugin generates the code for every property of type `T`.
88

99

10-
### `dynamodbRecord<T>(obj: T): Record<keyof T, AttributeValue>`
10+
### `dynamodbRecord<T>(obj: T, shouldLenientTypeCheck?: boolean): Record<keyof T, AttributeValue>`
1111

1212
This plugin replaces `dynamodbRecord<T>(obj: T)` invocation with `Record<keyof T, AttributeValue>` value that is defined in aws-sdk-js-v3 according to the type `T` and the contents of the object.
1313

1414
This plugin powers the users can do drop-in replacements for the existing `Record<keyof T, AttributeValue>` value and/or the generator with `dynamodbRecord<T>(obj: T)` function.
1515

16-
### `fromDynamodbRecord<T>(attrs: Record<string, AttributeValue>): T`
16+
### `fromDynamodbRecord<T>(attrs: Record<string, AttributeValue>, shouldLenientTypeCheck?: boolean): T`
1717

1818
This replaces `fromDynamodbRecord<T>(attrs: Record<string, AttributeValue>)` invocation with the object which has type `T`. This method is responsible to translate the DynamoDB attributes to the actual TypeScript object, i.e. unmarshalling.
1919

0 commit comments

Comments
 (0)