Permalink
Browse files

added some copy to explain callback signatures

  • Loading branch information...
1 parent b260aad commit e403b0001030a2cc79f66306cbe2d18716eea4cf @dickhardt dickhardt committed with Ryan Fitzgerald Jan 31, 2012
Showing with 4 additions and 2 deletions.
  1. +4 −2 README.md
View
@@ -38,6 +38,8 @@ If you would prefer to manage your own client, potentially with different auth p
accessKeyId: "AWSAccessKey", secretAccessKey: "SecretAccessKey"
});
```
+## Callback Signature
+Callbacks return (error, [results], meta) where results are the returned data and meta is the extra information returned by DynamoDB
## API Documentation
@@ -70,7 +72,7 @@ The CreateTable operation adds a new table to your account. For more info see [h
By default `createTable` will create the given table with a primary key of id : String, a read capacity of 10 and write capacity of 5.
``` js
- dynode.createTable("ExampleTable", function (error));
+ dynode.createTable("ExampleTable", console.log);
```
`createTable` accepts an options hash to override any of the table creation defaults.
@@ -87,7 +89,7 @@ Returns an array of all the tables associated with the current account. For more
By default `listTables` will list all of your DynamoDB tables.
``` js
- dynode.listTables(function (error, tables));
+ dynode.listTables(console.log);
```
You can also pass in options to filter which tables to list. See [Amazon's docs][listTablesDocs] for more info

0 comments on commit e403b00

Please sign in to comment.