\n\n[](https://github.com/Parana-Games/tinymo/actions/workflows/test.yml)\n\n**tinymo** simplifies constructing DynamoDB's JSON-based command inputs.\n\n# From this:\n```typescript\nconst update = {\n TableName: 'users',\n Key: { \n id: 'bob' \n },\n UpdateExpression: 'SET #orders :orders',\n ConditionExpression: '#age >= :ageCondition',\n ExpressionAttributeNames: { \n '#age': 'age', \n '#orders': 'orders' \n },\n ExpressionAttributeValues: { \n ':ageCondition': 18, \n ':orders': 5\n }\n}\n``` \n# To this:\n```typescript\ntinymo.update('users', { id: 'bob' }).set('orders', 5).condition('age', '>=', 18)\n```\n\n# Installation\n```\nnpm i @parana-games/tinymo\n```\n# How to Use\n1. Import:\n```typescript\nimport { tinymo } from '@parana-games/tinymo';\n```\n2. Create requests:\n> **tinymo** supports all of `DocumentClient`'s requests:\n```typescript\nconst update = tinymo.update('table', { name: 'John' })\nconst put = tinymo.put('table', someItem)\nconst deleteRequest = tinymo.delete('table', { id: 1 })\nconst get = tinymo.get('table', { id: 'id' })\nconst batchGet = tinymo.batchGet()\nconst batchWrite = tinymo.batchWrite()\nconst query = tinymo.query('table')\nconst scan = tinymo.scan('table')\nconst transactGet = tinymo.transactGet()\nconst transaction = tinymo.transaction()\n```\n3. Customize requests:\n> Request options are accessed through members of the class:\n```typescript\nget.attributes('id', 'name')\n\nquery.key('sk', '>=', 'order#100').filter('type', '=', 'refund')\n\nscan.consistentRead = true\n\nupdate.returnValues = 'ALL_NEW'\n```\n4. Execute with `.run()`:\n> Every request is executable with `run()`\n```typescript\nawait transaction.run()\n\nconst queryResponse = await query.run()\n\nconst batchGetResponse = await batchGet.run()\n\nPromise.all([put, update, deleteRequest].map(request => request.run()));\n```\n# Transactions\n**There are two ways of adding writes to a transaction:**\n1. Using the `update`, `put` and `delete` methods:\n>These methods add the corresponding write item to the list and return it, \n>so you can manipulate and pass it around with ease.\n```typescript\nconst update = transaction.update('users', { id: 'dan' })\nupdate.add('balance', 10);\n\ntransaction.put('users', { id: 'john', balance: 20 });\ntransaction.delete('orders', { id: '123' });\n```\n\n2. Using the `push` method, which accepts `Write` objects.\n> `Write` is the base class of `Update`, `Put` and `Delete`. \n```typescript\nconst writes: Write[] = generateWrites(); \n\n// Sometimes you have just one update to make, so a transaction is overkill.\nif (writes.length > 1) {\n await transaction.push(...writes).run();\n} else (writes.length === 0) {\n await writes[0].run(); \n}\n```\n# Testability\nGenerate pure DynamoDB JSON-based command inputs with `build()`:\n```typescript\nconst put = tinymo.put('games', { name: 'pool-stars' });\nput.build()\n```\n↓\n```typescript\n{\n 'TableName': 'games',\n 'Item': {\n 'name': 'pool-stars'\n }\n}\n```\nUseful for tiny unit tests!\n\n\n# Using without the tinymo Client\nSend commands using your DynamoDBClient:\n```typescript\nimport { Delete } from '@parana-games/tinymo';\n\nconst tinymoDelete = new Delete('users', { name: 'john' });\nconst command = new DeleteCommand(tinymoDelete.build());\nconst dynamoDBClient = new DynamoDBClient({});\nawait dynamoDBClient.send(command);\n```\n>️ Don't use run() when creating tinymo objects with new. They won't have an associated client.\n```typescript\nimport { Scan } from '@parana-games/tinymo';\n\nconst scan = new Scan('users');\nawait scan.run(); // error thrown as this instance is clientless\n```\n\n## Use `TinymoClient.setDocumentClient` to set your own DocumentClient\n```typescript\nTinymoClient.setDocumentClient(myCustomDocumentClient); // Useful when using X-Ray!\n```\n\n# Documentation\ntinymo aligns strictly with DynamoDB's API, so you can simply [refer to its documentation](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/Welcome.html).\n\n## Contributing\nIf you think we've missed something or can do something better, feel free opening an issue or submitting a pull request.\n","readmeFilename":"readme.md"}
![](\"https://raw.githubusercontent.com/Parana-Games/tinymo/main/docs/logo.png\"){kind=logo}
\n