[BUG] Property startAt does not exist on Scan.

Summary:

The property startAt, which according to documentation should exist on startAt but it is giving me an error that it does not exist. We were migrating from dynamoose v1 to v2. However, this is not happening on dynamoose v2.7.3 but on the latest release v2.8.0.

Code sample:

Schema

export const model = model<Model & Document>(
  env('TABLE_NAME'),
  new Schema(
    {
      customerId: {
        type: String,
        hashKey: true,
      },
      productId: {
        type: String,
        rangeKey: true,
      },
    },
    { timestamps: true }
  )
);

Model

export type Model = {
  readonly customerId: string;
  readonly productId: string;
  readonly createdAt: Date;
  readonly updatedAt: Date;
};

General

export const getAllItems = async (): Promise<
  readonly Model[]
> => {
  const dataFetch = async (
     _lastKey?: Key
  ): Promise<readonly Model[]> => {
    const response =
    // _lastKey === undefined
      await model.scan().exec()
    const moreDocs = model.scan().startAt(response.lastKey)

Current output and behavior (including stack trace):

When we run our tests it says

Property 'startAt' does not exist on type 'Scan<CustomerCartItem & Document>'.

    73     const moreDocs = customerCart.scan().startAt(response.lastKey)

Expected output and behavior:

Should clear all the tests.

Environment:

Operating System: MacOS Operating System Version: 11.5.2 Node.js version (node -v): 12.21.0 NPM version: (npm -v): 6.14.11 Dynamoose version: 2.8.0

Other:

• [ x ] I have read through the Dynamoose documentation before posting this issue
• [ x ] I have searched through the GitHub issues (including closed issues) and pull requests to ensure this issue has not already been raised before
• [ x ] I have searched the internet and Stack Overflow to ensure this issue hasn’t been raised or answered before
• [ x ] I have tested the code provided and am confident it doesn’t work as intended
• [ x ] I have filled out all fields above
• [ x ] I am running the latest version of Dynamoose

[nirwanrajnp]

Thank you so much for making that clear @fishcharlie

[fishcharlie]

@nirwanrajnp I have improved the documentation in the PR #1256. It will be deployed to dynamoosejs.com with the next release. Hope this helps!