Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change QueryKey and ScanKey type to any #419

Merged
merged 1 commit into from
Sep 5, 2018

Conversation

cakedev
Copy link
Contributor

@cakedev cakedev commented Sep 4, 2018

The method startAt requires an object with the same format as the one given by the lastKey value not a String

Summary:

The type definition is incorrect for the types QueryKey and ScanKey since these two types are used for the startAt function.

The startAt key expects an object with the same format as the one given by the lastKey field when executing a query or scan and currently it was asking for a String which is causing a problem when trying to send the value.

There was a workaround for this using:

myquery.startAt({ id: { S: "someid" } } as any).exec();

But that's just not OK.

Code sample:

This should work now:

myquery.startAt({ id: { S: "someid" } }).exec();

Type (select 1):

  • Bug fix
  • Feature implementation
  • Documentation improvement
  • Testing improvement
  • Test added to report bug (GitHub issue #--- @---)
  • Something not listed here

Is this a breaking change? (select 1):

  • 🚨 YES 🚨
  • No
  • I'm not sure

Is this ready to be merged into Dynamoose? (select 1):

  • Yes
  • No

Are all the tests currently passing on this PR? (select 1):

  • Yes
  • No

Other:

  • I have searched through the GitHub pull requests to ensure this PR has not already been submitted
  • I have updated the Dynamoose documentation (if required) given the changes I made
  • I have added/updated the Dynamoose test cases (if required) given the changes I made
  • I have run npm test from the root of the project directory to ensure all tests continue to pass
  • I agree that all changes made in this pull request may be distributed and are made available in accordance with the Dynamoose license
  • All of my commits and commit messages are detailed, explain what changes were made, and are easy to follow and understand
  • I have confirmed that all my code changes are indented properly using 2 spaces
  • I have filled out all fields above

The method startAt requires an object with the same format as the one given by the lastKey value not a String
@coveralls
Copy link

coveralls commented Sep 4, 2018

Pull Request Test Coverage Report for Build 611

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 84.159%

Totals Coverage Status
Change from base Build 609: 0.0%
Covered Lines: 1824
Relevant Lines: 2099

💛 - Coveralls

@fishcharlie
Copy link
Member

@cakedevp Thanks for this!

@fishcharlie fishcharlie merged commit a215992 into dynamoose:master Sep 5, 2018
@fishcharlie fishcharlie mentioned this pull request Sep 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants