Provide an API for getting the AWS Dynamo CreateTable parameters

[aneilbaboo]

This is a small change which extracts the functionality for generating the Dynamo CreateTable API arguments from Table.prototype.createTable to Table.prototype.dynamoParameters.

I use Serverless to manage deployment (and teardown) of DynamoDB tables. To do this, I need the AWS CreateTable params. I'd prefer to avoid having to keep the Serverless table descriptions in sync with Dynogels, and it's nicer to describe the tables in Dynogels anyway. This change enables that. It's probably useful in some other contexts too.

The new API is:

MyModel.dynamoParameters(options);

Where options are the same as the first argument to Table.prototype.createTable.

Note:

Changed the method from makeCreateTableParams to dynamoParameters.

[cdhowie]

I support this change. Would you mind adding some unit tests for this new method?

[aneilbaboo]

Will do.

[aneilbaboo]

Hi @cdhowie

I've got 4 new commits:

• Duplicate & modify the existing #createTable tests to test the same logic in makeCreateTableParams
• Add a test that table.createTable calls dynamo.createTable with the result from makeCreateTableParams
• Remove the redundant #createTable tests
• Renamed makeCreateTableParams to dynamoParameters

I'm not sure how you feel about that third commit. I can roll it back if you'd like to keep the redundant createTable tests.

[aneilbaboo]

The test is failing because of an unrelated error at test/integration/integration-test.js:544:23. Same problem on master.

[aneilbaboo]

@cdhowie - I made a final tweak - renamed the API to dynamoParameters, which I think reads nicer.

[aneilbaboo]

Also updated the README.

[cdhowie]

@aneilbaboo I think the prior name makes more sense. The new name doesn't make it clear what the parameters are used for.

[aneilbaboo]

@cdhowie How about dynamoCreateTableParameters? That makes it clear what service & what purpose it's for. makeTableCreateParameters was looking a bit confusing in my code.

[aneilbaboo]

@cdhowie - I pushed a commit that changes it to model.dynamoCreateTableParams() - is that ok? Or do you want me to revert to model.makeCreateTableParams()?

[cdhowie]

@aneilbaboo The only issue I see remaining is the presence of the yarn-error.log file. Can you remove that?

[aneilbaboo]

Oooof. Sorry about that.

[aneilbaboo]

Thanks, @cdhowie - Removed it and added yarn-error.log to .gitignore