@ttoss/postgresdb 0.2.1 → 0.2.2

package/README.md

@@ -122,3 +122,30 @@ All [Sequelize options](https://sequelize.org/api/v6/class/src/sequelize.js~sequ
 ### Sequelize decorators
 
 This package exports all decorators from [sequelize-typescript](https://www.npmjs.com/package/sequelize-typescript), i.e., `@Table`, `@Column`, `@ForeignKey`, etc.
+
+## Types
+
+### `ModelColumns<T>`
+
+A type that represents the columns of a model.
+
+```typescript
+import { Column, Model, type ModelColumns, Table } from '@ttoss/postgresdb';
+
+@Table
+class User extends Model<User> {
+  @Column
+  declare name?: string;
+
+  @Column
+  declare email: string;
+}
+
+/**
+ * UserColumns = {
+ *  name?: string;
+ *  email: string;
+ * }
+ */
+type UserColumns = ModelColumns<User>;
+```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ModelCtor, Sequelize, SequelizeOptions } from 'sequelize-typescript';
+import { ModelCtor, Sequelize, SequelizeOptions, Model } from 'sequelize-typescript';
 export * from 'sequelize-typescript';
 
 type Options<Models> = Omit<SequelizeOptions, 'models' | 'dialect'> & {
@@ -10,4 +10,6 @@ declare const initialize: <Models extends {
     sequelize: Sequelize;
 } & Models>;
 
-export { initialize };
+type ModelColumns<T> = Omit<T, keyof Model> & Pick<Model, 'id' | 'createdAt' | 'updatedAt'>;
+
+export { type ModelColumns, initialize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/postgresdb",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "A library to handle PostgreSQL database connections and queries",
   "license": "MIT",
   "author": "ttoss",