TypeScript
Esta guia sólo es útil si estás usando Dynamoose con TypeScript. Si lo estás utilizando con JavaScript en lugar de TypeScript, puedes omitir esta página.
Resumen
Dynamoose TypeScript Soporte es en beta.
Dynamoose está construido enteramente en TypeScript y se envía con tipos TypeScript. Esto significa que cuando se use Dynamoose en TypeScript tendrás todo el acceso a las caracteresiticas de autocompletado y seguridad de tipos que frece TypeScript.
Iniciando
Para empezar a usar Dynamoose en tu proyecto TypeScript, simplemente instala e importa (usando ESModules) Dynamoose como se ha descrito en páginas anteriores.
No hay necesidad de instalar @types paquetes adicionales con el objetivo de usar Dynamoose con TypeScript ya que los tipos están incluidos con el paquete Dynamoose.
Después de eso, siempre que tengas TypeScript ya configurado en tu proyecto y editor de texto debes estar listo para empezar a usar Dynamoose con TypeScript.
Preguntas frecuentes
¿Qué significa beta en términos de soporte Jsdoc?
Soporte TypeScript Beta significa que los tipos pueden estar equivocados o perdidos. Esto puede incluir cosas como tipos incorrectos siendo utilizados, métodos/funciones/propiedades, etc. faltantes.
¿Que Soporte TypeScript esté en fase beta significa que no debería usarlo?
NO. Recomendamos usar y probar el soporte TypeScript a pesar de estar en fase beta. Significa que debes ser consciente de que los tipos pueden ser incorrectos o incompletos. Si notas algún problema, por favor envía una solicitud de extracción o problema.
¿Debo confiar más en la documentación o en los tipos TypeScript?
En el caso de que la documentación y los tipos TypeScript no se alineen o den información diferente, siempre debes considerar la documentación como la fuente principal de la verdad. Si tienes razones para creer que ambos son incorrectos o los tipos TypeScript son más precisos que la documentación, por favor envía una solicitud de extracción o problema.
¿Existe alguna diferencia entre usar Dynamoose con TypeScript y JavaScript?
No. No hay diferencias entre el uso de Dynamoose con TypeScript y JavaScript, excepto tipos más estrictos con TypeScript. El comportamiento subyacente, API y la funcionalidad de Dynamoose sigue siendo exactamente igual.
¿Qué significa el soporte TypeScript? ¿Qué tipos están incluidos?
El soporte TypeScript incluye soporte para todas las funciones/métodos, y propiedades de Dynamoose. No tiene tipos ni contratos entre los esquemas y elementos que creas. Todas las comprobaciones de tipo entre tu esquema y los elementos se manejan en tiempo de ejecución como parte de Dynamoose, y no forman parte de los tipos de TypeScript.
En algún momento esperamos explorar el potencial de añadir tipos para asegurar que tus elementos se ajusten a tus Esquemas. Sin embargo, esto plantea muchas preguntas sobre si es posible tener tipos tan dinámicos en TypeScript, así como casos extremos que aún no se han considerado.
¿Qué debo hacer si tengo preguntas adicionales?
- Contactarme
- Únete a nuestro Slack
- Crea un problema en el repositorio Dynamoose