kysely 0.8.1 → 0.9.3

package/dist/esm/schema/schema.js

@@ -33,12 +33,47 @@ export class SchemaModule {
      * ```ts
      * await db.schema
      *   .createTable('person')
-     *   .addColumn('id', 'int', col => col.primaryKey().increments())
+     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
      *   .addColumn('first_name', 'varchar', col => col.notNull())
      *   .addColumn('last_name', 'varchar', col => col.notNull())
      *   .addColumn('gender', 'varchar')
      *   .execute()
      * ```
+     *
+     * @example
+     * This example creates a table with a foreign key. Not all database
+     * engines support column-level foreign key constraint definitions.
+     * For example if you are using MySQL 5.X see the next example after
+     * this one.
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('pet')
+     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('owner_id', 'integer', col => col
+     *     .references('person.id')
+     *     .onDelete('cascade')
+     *   )
+     *   .execute()
+     * ```
+     *
+     * @example
+     * This example adds a foreign key constraint for a columns just
+     * like the previous example, but using a table-level statement.
+     * On MySQL 5.X you need to define foreign key constraints like
+     * this:
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('pet')
+     *   .addColumn('id', 'integer', col => col.primaryKey().increments())
+     *   .addColumn('owner_id', 'integer')
+     *   .addForeignKeyConstraint(
+     *     'pet_owner_id_foreign', ['owner_id'], 'person', ['id'],
+     *     (constraint) => constraint.onDelete('cascade')
+     *   )
+     *   .execute()
+     * ```
      */
     createTable(table) {
         return new CreateTableBuilder({

package/dist/esm/util/object-utils.d.ts

@@ -1,18 +1,19 @@
 /// <reference types="node" />
 export declare type PrimitiveValue = string | number | boolean | null | Date | Buffer | BigInt;
-export declare function isEmpty(obj: ArrayLike<any> | string | object | Buffer): boolean;
-export declare function isString(obj: any): obj is string;
-export declare function isNumber(obj: any): obj is number;
-export declare function isBoolean(obj: any): obj is boolean;
-export declare function isNull(obj: any): obj is null;
-export declare function isDate(obj: any): obj is Date;
-export declare function isBuffer(obj: any): obj is Buffer;
-export declare function isBigInt(obj: any): obj is BigInt;
-export declare function isPrimitive(obj: any): obj is PrimitiveValue;
-export declare function isFunction(obj: any): obj is Function;
-export declare function isObject(obj: any): obj is Record<string, any>;
+export declare function isEmpty(obj: ArrayLike<unknown> | string | object | Buffer): boolean;
+export declare function isString(obj: unknown): obj is string;
+export declare function isNumber(obj: unknown): obj is number;
+export declare function isBoolean(obj: unknown): obj is boolean;
+export declare function isNull(obj: unknown): obj is null;
+export declare function isDate(obj: unknown): obj is Date;
+export declare function isBuffer(obj: unknown): obj is Buffer;
+export declare function isBigInt(obj: unknown): obj is BigInt;
+export declare function isPrimitive(obj: unknown): obj is PrimitiveValue;
+export declare function isFunction(obj: unknown): obj is Function;
+export declare function isObject(obj: unknown): obj is Record<string, unknown>;
 export declare function getLast<T>(arr: ArrayLike<T>): T | undefined;
 export declare function freeze<T>(obj: T): Readonly<T>;
 export declare function asArray<T>(arg: T | T[]): T[];
 export declare function asReadonlyArray<T>(arg: T | ReadonlyArray<T>): ReadonlyArray<T>;
 export declare function isReadonlyArray(arg: unknown): arg is ReadonlyArray<unknown>;
+export declare function noop<T>(obj: T): T;

package/dist/esm/util/object-utils.js

@@ -41,7 +41,7 @@ export function isFunction(obj) {
     return typeof obj === 'function';
 }
 export function isObject(obj) {
-    return obj && typeof obj === 'object';
+    return typeof obj === 'object' && obj !== null;
 }
 export function getLast(arr) {
     return arr[arr.length - 1];
@@ -68,3 +68,6 @@ export function asReadonlyArray(arg) {
 export function isReadonlyArray(arg) {
     return Array.isArray(arg);
 }
+export function noop(obj) {
+    return obj;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.8.1",
+  "version": "0.9.3",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",