chore: ts type definition correct, doc

cyjake · Apr 26, 2022 · f2ca523 · f2ca523
1 parent 854863d
commit f2ca523
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 4 deletions.
diff --git a/docs/basics.md b/docs/basics.md
@@ -100,7 +100,7 @@ const { BIGINT, STRING } = Bone.DataTypes;
 class Shop extends Bone {
   static attributes = {
     id: { type: BIGINT, primaryKey: true },
-    name: { type: STRING },
+    name: STRING,
   }
 }
 

diff --git a/docs/querying.md b/docs/querying.md
@@ -507,6 +507,7 @@ We can reference these table aliases futher after the join, such as `.where()` o
 
 ```js
 Post.join(Comment, 'posts.id = comments.postId').where('comments.id = 1')
+Post.join(Comment, 'posts.id = comments.postId').where({ 'comments.id': 1 })
 ```
 
 ## Scopes

diff --git a/docs/zh/basics.md b/docs/zh/basics.md
@@ -99,7 +99,7 @@ const { BIGINT, STRING } = Bone.DataTypes;
 class Shop extends Bone {
   static attributes = {
     id: { type: BIGINT, primaryKey: true },
-    name: { type: STRING },
+    name: STRING,
   }
 }
 

diff --git a/docs/zh/querying.md b/docs/zh/querying.md
@@ -501,6 +501,7 @@ SELECT * FROM posts LEFT JOIN comments ON posts.id = comments.post_id LEFT JOIN
 
 ```js
 Post.join(Comment, 'posts.id = comments.postId').where('comments.id = 1')
+Post.join(Comment, 'posts.id = comments.postId').where({ 'comments.id': 1 })
 ```
 
 ## 查询限定

diff --git a/test/types/custom_driver.ts → test/types/custom_driver.test.ts b/test/types/custom_driver.ts → test/types/custom_driver.test.ts
diff --git a/test/types/data_types.ts → test/types/data_types.test.ts b/test/types/data_types.ts → test/types/data_types.test.ts
@@ -1,5 +1,5 @@
 import { strict as assert } from 'assert';
-import Realm, { Bone, DataTypes } from '../..';
+import Realm, { Bone, DataTypes } from '../../types';
 
 describe('=> Data types (TypeScript)', function() {
   const { STRING, TEXT, BLOB } = DataTypes;

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -179,11 +179,17 @@ export interface ColumnMeta {
   comment?: string;
   datetimePrecision?: string;
 }
+
+declare type validator = Literal | Function | Array<Literal | Literal[]>;
+
 export interface AttributeMeta extends ColumnMeta {
   jsType?: Literal;
   type: DataType;
   virtual?: boolean,
   toSqlString: () => string;
+  validate: {
+    [key: string]: validator;
+  }
 }
 
 interface RelateOptions {
@@ -442,7 +448,7 @@ export class Collection<T extends Bone> extends Array<T> {
 }
 
 export class Bone {
-  static DataTypes: DataType;
+  static DataTypes: typeof DataType;
 
   /**
    * get the connection pool of the driver
-Original file line number
+Diff line change
@@ Expand Up @@
     ```js
     Post.join(Comment, 'posts.id = comments.postId').where('comments.id = 1')
+    Post.join(Comment, 'posts.id = comments.postId').where({ 'comments.id': 1 })
     ```
     ## Scopes
@@ Expand Down @@