@types/sequelize

What is @types/sequelize?

@types/sequelize provides TypeScript type definitions for the Sequelize ORM, allowing developers to use Sequelize with TypeScript and benefit from type checking and autocompletion.

What are @types/sequelize's main functionalities?

Model Definition

Defines a model with specific attributes and their types. This allows for type-safe model definitions in TypeScript.

const User = sequelize.define('User', {
  username: {
    type: DataTypes.STRING,
    allowNull: false
  },
  birthday: {
    type: DataTypes.DATE
  }
});

Model Synchronization

Synchronizes all defined models to the database. This is useful for ensuring that the database schema matches the model definitions.

await sequelize.sync({ force: true });

Querying

Performs a query to retrieve all instances of the User model. TypeScript ensures that the returned data matches the User model definition.

const users = await User.findAll();

Associations

Defines associations between models, such as one-to-many or many-to-many relationships. TypeScript helps ensure that these associations are correctly defined and used.

User.hasMany(Post);
Post.belongsTo(User);

Other packages similar to @types/sequelize

@types/mongoose

@types/mongoose provides TypeScript type definitions for Mongoose, an ODM (Object Data Modeling) library for MongoDB and Node.js. Mongoose is specifically designed for MongoDB, offering schema-based solutions and validation, making it a good choice for MongoDB users.

README

Installation

npm install --save @types/sequelize

Summary

This package contains type definitions for Sequelize 3.4.1 (http://sequelizejs.com).

Details

Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/sequelize

Additional Details

• Last updated: Fri, 08 Jul 2016 19:22:07 GMT
• File structure: ProperModule
• Library Dependencies: lodash, bluebird, validator
• Module Dependencies: none
• Global values: sequelize

Credits

These definitions were written by samuelneff https://github.com/samuelneff, Peter Harris https://github.com/codeanimal, Ivan Drinchev https://github.com/drinchev.