dynamoose/dynamoose

[BUG] Exporting a model is not possible in typescript

Open

Aperta il 2 giu 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (2025 star) (349 fork)batch import
help wantedstatus:todotype:bug

Descrizione

Summary:

When I try to export a Model, I get the following error:

The inferred type of 'CatModel' cannot be named without a reference to '../lib/nodejs/node_modules/dynamoose/dist/General'. This is likely not portable. A type annotation is necessary.

Code sample:

Model

export const CatModel = dynamoose.model("Cat", {"id": Number, "name": String});

General

Current output and behavior (including stack trace):

Expected output and behavior:

Environment:

Operating System: osx Operating System Version: 11.4 Node.js version (node -v): v14.17.0 NPM version: (npm -v): 6.14.13 Dynamoose version: v2.7.3

Other information (if applicable):

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

Guida contributor

Tech stack
typescriptnodejs
Dominio
backenddeveloper experience
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
TypeScriptDynamoose
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45
Direzione di ricerca
Investigate the type definition of Model in the Dynamoose library, particularly the General type referenced in the error. Look at the dist folder for type definitions (e.g., dist/general.d.ts) and determine if adding an explicit return type annotation to the model function or adjusting the exported type resolves the issue. Consider checking the source code in src/ for the model function and its TypeScript definitions. Since the issue has no comments or PRs, a fix likely involves modifying the type definitions to allow proper export of model instances.