{"_id":"@bippo-nest/dynamodb-doc-client","_rev":"2-c3a9184fac0703cd0c5e046e57961f53","name":"@bippo-nest/dynamodb-doc-client","dist-tags":{"next":"0.0.2","latest":"0.0.7"},"versions":{"0.0.1":{"name":"@bippo-nest/dynamodb-doc-client","version":"0.0.1","type":"commonjs","license":"MIT","keywords":["nest","dynamodb","client"],"repository":{"type":"git","url":"git+https://github.com/wiowou/bippo-nest.git"},"homepage":"https://github.com/wiowou/bippo-nest/blob/master/libs/dynamodb-doc-client/README.md","peerDependencies":{"@aws-sdk/client-dynamodb":"^3.0.0","@aws-sdk/lib-dynamodb":"^3.0.0","@aws-sdk/util-dynamodb":"^3.0.0","@nestjs/common":"^9.0.0","@nestjs/core":"^9.0.0","tslib":"^2.0.0"},"devDependencies":{},"dependencies":{},"main":"./src/index.js","types":"./src/index.d.ts","gitHead":"441c71e685850a3e237a374249d47e3ada1a8558","description":"This library was generated with [Nx](https://nx.dev).","bugs":{"url":"https://github.com/wiowou/bippo-nest/issues"},"_id":"@bippo-nest/dynamodb-doc-client@0.0.1","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-YJDOICV4yNJ8FbzZGJpGm00qWfJJ94zqiShZrLmMXbPPFU4CoOHoPVGR0pzUoqzKb91tESBBGRrCqCvyn5ozHg==","shasum":"3ebb34787f04ec24b1fc00ae8dcf0b1543d65ce1","tarball":"https://registry.npmjs.org/@bippo-nest/dynamodb-doc-client/-/dynamodb-doc-client-0.0.1.tgz","fileCount":14,"unpackedSize":12198,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDMd3l8plaJMd59ImEECzZu5rbVtb/wsnoFNkz22FFOegIhAPIlTwDfmzBPc+tlTQ9LsuVXSmKreABtnsg49E1k5S5t"}]},"_npmUser":{"name":"bkap799","email":"bkap799@gmail.com"},"directories":{},"maintainers":[{"name":"bkap799","email":"bkap799@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dynamodb-doc-client_0.0.1_1684725785705_0.23465389482261645"},"_hasShrinkwrap":false},"0.0.2":{"name":"@bippo-nest/dynamodb-doc-client","version":"0.0.2","type":"commonjs","license":"MIT","keywords":["nest","dynamodb","client"],"repository":{"type":"git","url":"git+https://github.com/wiowou/bippo-nest.git"},"homepage":"https://github.com/wiowou/bippo-nest/blob/master/libs/dynamodb-doc-client/README.md","peerDependencies":{"@aws-sdk/client-dynamodb":"^3.0.0","@aws-sdk/lib-dynamodb":"^3.0.0","@aws-sdk/util-dynamodb":"^3.0.0","@nestjs/common":"^9.0.0","@nestjs/core":"^9.0.0","tslib":"^2.0.0"},"devDependencies":{},"dependencies":{},"main":"./src/index.js","types":"./src/index.d.ts","readme":"# dynamodb-doc-client\n\n[AWS DynamoDB Document Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html) module for [Nest](https://github.com/nestjs/nest).\n\n## Installation\n\n```bash\n$ npm install --save @bippo-nest/dynamodb-doc-client\n```\n\n## Quick Start\n\n**1. Add import into your app module**\n\n`src/app.module.ts`\n\n```ts\nimport { Module } from '@nestjs/common';\n\nimport { AppController } from './app.controller';\nimport { AppService } from './app.service';\n\nimport { DynamoDBDocClientModule } from '@bippo-nest/dynamodb-doc-client';\n\n@Module({\n  imports: [DynamoDBDocClientModule.forRoot()],\n  controllers: [AppController],\n  providers: [AppService],\n})\nexport class AppModule {}\n```\n\n`forRoot()` optionally accepts the following objects in this order:\n[DynamoDBClientConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#constructor-property),\n[marshallOptions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_util_dynamodb.marshallOptions.html),\n[unmarshallOptions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_util_dynamodb.unmarshallOptions.html)\n\n**2. Inject and use your model**\n\n`src/app.service.ts`\n\n```ts\nimport { Injectable } from '@nestjs/common';\n\nimport { DynamoDBDocClientService } from '@bippo-nest/dynamodb-doc-client';\n\n@Injectable()\nexport class AppService {\n  constructor(private readonly docClient: DynamoDBDocClientService) {}\n\n  async createData() {\n    const params = {\n      TableName: 'MyTable',\n      Item: {\n        pk: 'myPK',\n        sk: '001',\n        foo: 17,\n        bar: 'what a wonderful day',\n      },\n    };\n    try {\n      await this.docClient.clientPut(params);\n    } catch (error) {\n      console.log(error);\n    }\n  }\n}\n```\n\n## Pass-Through Methods\n\nAll methods that start with the `client` prefix pass arguments directly to the document client\n\n- [clientBatchGet](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#batchGet-property)\n- [clientBatchWrite](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#batchWrite-property)\n- [clientDelete](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#delete-property)\n- [clientGet](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#get-property)\n- [clientPut](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#put-property)\n- [clientQuery](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#query-property)\n- [clientScan](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property)\n- [clientTransactGet](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#transactGet-property)\n- [clientTransactWrite](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#transactWrite-property)\n- [clientUpdate](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#update-property)\n","readmeFilename":"README.md","gitHead":"be4ce4394e9070b25c9d05fd569419de8f6223c8","description":"[AWS DynamoDB Document Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html) module for [Nest](https://github.com/nestjs/nest).","bugs":{"url":"https://github.com/wiowou/bippo-nest/issues"},"_id":"@bippo-nest/dynamodb-doc-client@0.0.2","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-eVdovrXa7YGMUxWkuTjzqrltoFPRPSVH+cvYqYrbLerWVLPWxuWsATMW+Sr3hwjy5FLzVmbbHCrmCaEetbcARg==","shasum":"91b5432e0cca27e3f85b0a65b7dd921827d17e9e","tarball":"https://registry.npmjs.org/@bippo-nest/dynamodb-doc-client/-/dynamodb-doc-client-0.0.2.tgz","fileCount":14,"unpackedSize":15047,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDINUV/vaIcD3xxee3AL3qCTPB5A6qEt/kjzuhIgJlp5AiEAjNuRtaiqxh9LAiuhlbvsj+2Z/EsCPl9MGPtWEnmdddo="}]},"_npmUser":{"name":"bkap799","email":"bkap799@gmail.com"},"directories":{},"maintainers":[{"name":"bkap799","email":"bkap799@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dynamodb-doc-client_0.0.2_1684807447470_0.6428397339348655"},"_hasShrinkwrap":false},"0.0.7":{"name":"@bippo-nest/dynamodb-doc-client","version":"0.0.7","type":"commonjs","license":"MIT","keywords":["nest","dynamodb","client"],"repository":{"type":"git","url":"git+https://github.com/wiowou/bippo-nest.git"},"homepage":"https://github.com/wiowou/bippo-nest/blob/master/libs/dynamodb-doc-client/README.md","peerDependencies":{"@aws-sdk/client-dynamodb":"^3.0.0","@aws-sdk/lib-dynamodb":"^3.0.0","@aws-sdk/util-dynamodb":"^3.0.0","@nestjs/common":"^9.0.0","@nestjs/core":"^9.0.0","tslib":"^2.0.0"},"devDependencies":{},"dependencies":{},"main":"./src/index.js","types":"./src/index.d.ts","gitHead":"3b97f46b17196de745853b9c03da6879fa56cc6d","description":"[AWS DynamoDB Document Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html) module for [Nest](https://github.com/nestjs/nest).","bugs":{"url":"https://github.com/wiowou/bippo-nest/issues"},"_id":"@bippo-nest/dynamodb-doc-client@0.0.7","_nodeVersion":"18.16.0","_npmVersion":"9.5.1","dist":{"integrity":"sha512-ynCND0HWSYJoP63niMOs9/iJ5qBe1ZpoGipeihmqmCqsUNf1d5cFWKnvMaJiBgC+SLaOa7MW+INC4OUV4KpGpg==","shasum":"0c749bc5254fc78bd6a8db530484410d5643f954","tarball":"https://registry.npmjs.org/@bippo-nest/dynamodb-doc-client/-/dynamodb-doc-client-0.0.7.tgz","fileCount":14,"unpackedSize":15047,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGFb2Bi268XBumrzifjFxsK+IFhMZVKmwDdTQ97QITvgAiEA1jnPTv22d/zRsyYxUrLWJu7b9VmWc/i3YIpwSwfznus="}]},"_npmUser":{"name":"bkap799","email":"bkap799@gmail.com"},"directories":{},"maintainers":[{"name":"bkap799","email":"bkap799@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/dynamodb-doc-client_0.0.7_1684809606718_0.955285028820615"},"_hasShrinkwrap":false}},"time":{"created":"2023-05-22T03:23:05.622Z","0.0.1":"2023-05-22T03:23:05.864Z","modified":"2023-05-23T02:40:06.978Z","0.0.2":"2023-05-23T02:04:07.704Z","0.0.7":"2023-05-23T02:40:06.859Z"},"maintainers":[{"name":"bkap799","email":"bkap799@gmail.com"}],"description":"[AWS DynamoDB Document Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html) module for [Nest](https://github.com/nestjs/nest).","homepage":"https://github.com/wiowou/bippo-nest/blob/master/libs/dynamodb-doc-client/README.md","keywords":["nest","dynamodb","client"],"repository":{"type":"git","url":"git+https://github.com/wiowou/bippo-nest.git"},"bugs":{"url":"https://github.com/wiowou/bippo-nest/issues"},"license":"MIT","readme":"# dynamodb-doc-client\n\n[AWS DynamoDB Document Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html) module for [Nest](https://github.com/nestjs/nest).\n\n## Installation\n\n```bash\n$ npm install --save @bippo-nest/dynamodb-doc-client\n```\n\n## Quick Start\n\n**1. Add import into your app module**\n\n`src/app.module.ts`\n\n```ts\nimport { Module } from '@nestjs/common';\n\nimport { AppController } from './app.controller';\nimport { AppService } from './app.service';\n\nimport { DynamoDBDocClientModule } from '@bippo-nest/dynamodb-doc-client';\n\n@Module({\n  imports: [DynamoDBDocClientModule.forRoot()],\n  controllers: [AppController],\n  providers: [AppService],\n})\nexport class AppModule {}\n```\n\n`forRoot()` optionally accepts the following objects in this order:\n[DynamoDBClientConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#constructor-property),\n[marshallOptions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_util_dynamodb.marshallOptions.html),\n[unmarshallOptions](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/interfaces/_aws_sdk_util_dynamodb.unmarshallOptions.html)\n\n**2. Inject and use your model**\n\n`src/app.service.ts`\n\n```ts\nimport { Injectable } from '@nestjs/common';\n\nimport { DynamoDBDocClientService } from '@bippo-nest/dynamodb-doc-client';\n\n@Injectable()\nexport class AppService {\n  constructor(private readonly docClient: DynamoDBDocClientService) {}\n\n  async createData() {\n    const params = {\n      TableName: 'MyTable',\n      Item: {\n        pk: 'myPK',\n        sk: '001',\n        foo: 17,\n        bar: 'what a wonderful day',\n      },\n    };\n    try {\n      await this.docClient.clientPut(params);\n    } catch (error) {\n      console.log(error);\n    }\n  }\n}\n```\n\n## Pass-Through Methods\n\nAll methods that start with the `client` prefix pass arguments directly to the document client\n\n- [clientBatchGet](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#batchGet-property)\n- [clientBatchWrite](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#batchWrite-property)\n- [clientDelete](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#delete-property)\n- [clientGet](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#get-property)\n- [clientPut](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#put-property)\n- [clientQuery](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#query-property)\n- [clientScan](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#scan-property)\n- [clientTransactGet](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#transactGet-property)\n- [clientTransactWrite](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#transactWrite-property)\n- [clientUpdate](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html#update-property)\n","readmeFilename":"README.md"}