Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Typing: add typescript support for deferrable, new Primary/Unique syntax #4589

Merged
merged 3 commits into from
Jul 29, 2021
Merged

Improve Typing: add typescript support for deferrable, new Primary/Unique syntax #4589

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc82e93
add type support for deferrable, datetime
zeotuan Jul 27, 2021
16ef18d
remove typo
zeotuan Jul 27, 2021
eb0372e
fix lint: remove trailing space
zeotuan Jul 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 12 additions & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1884,6 +1884,7 @@ export declare namespace Knex {
boolean(columnName: string): ColumnBuilder;
date(columnName: string): ColumnBuilder;
dateTime(columnName: string, options?: Readonly<{useTz?: boolean, precision?: number}>): ColumnBuilder;
datetime(columnName: string, options?: Readonly<{useTz?: boolean, precision?: number}>): ColumnBuilder;
kibertoad marked this conversation as resolved.
Show resolved Hide resolved
time(columnName: string): ColumnBuilder;
timestamp(columnName: string, options?: Readonly<{useTz?: boolean, precision?: number}>): ColumnBuilder;
/** @deprecated */
Expand All @@ -1908,12 +1909,16 @@ export declare namespace Knex {
uuid(columnName: string): ColumnBuilder;
comment(val: string): TableBuilder;
specificType(columnName: string, type: string): ColumnBuilder;
primary(columnNames: readonly string[], options?: Readonly<{constraintName?: string, deferrable?: deferrableType}>): TableBuilder;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New type for primary using options object

/** @deprecated */
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add deprecate tag for old syntax

primary(columnNames: readonly string[], constraintName?: string): TableBuilder;
index(
columnNames: string | readonly (string | Raw)[],
indexName?: string,
indexType?: string
): TableBuilder;
unique(columnNames: readonly (string | Raw)[], options?: Readonly<{indexName?: string, deferrable?: deferrableType}>): TableBuilder;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added type for unique using options object

/** @deprecated */
unique(columnNames: readonly (string | Raw)[], indexName?: string): TableBuilder;
foreign(column: string, foreignKeyName?: string): ForeignConstraintBuilder;
foreign(
Expand All @@ -1936,10 +1941,15 @@ export declare namespace Knex {
}

interface AlterTableBuilder extends TableBuilder {}

type deferrableType = 'not deferrable' | 'immediate' | 'deferred';
interface ColumnBuilder {
index(indexName?: string): ColumnBuilder;
primary(options?: Readonly<{constraintName?: string, deferrable?: deferrableType}>): ColumnBuilder;
/** @deprecated */
primary(constraintName?: string): ColumnBuilder;

unique(options?: Readonly<{indexName?: string, deferrable?: deferrableType}>): ColumnBuilder;
/** @deprecated */
unique(indexName?: string): ColumnBuilder;
references(columnName: string): ReferencingColumnBuilder;
onDelete(command: string): ColumnBuilder;
Expand All @@ -1954,6 +1964,7 @@ export declare namespace Knex {
withKeyName(keyName: string): ColumnBuilder;
after(columnName: string): ColumnBuilder;
first(): ColumnBuilder;
deferrable(type: deferrableType): ColumnBuilder;
}

interface ForeignConstraintBuilder {
Expand Down