[BUG] Return type of model.get is missing | undefined

[JaakkoLipsanen]

Summary:

Return type of Model<T>.get is T, even though it returns undefined if item is not found. This behavior is also mentioned in the documentation.

Code sample:

Schema

const UserSchema = ...

Model

const UserModel = dynamoose.model<UserItem>(tableName, UserSchema);

General

const user = UserModel.get('non-existing-id');

Current output and behavior (including stack trace):

// type of user is UserItem

Expected output and behavior:

// type of user should be UserItem | undefined

Environment:

Dynamoose version: 3.2.0

Other:

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