Skip to content

Commit 12773c1

Browse files
committed
chore(db-*): import migration args as type
1 parent 68a5f5c commit 12773c1

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

Diff for: docs/database/migrations.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ all changes that you attempt to make within the migration, and the `down` should
3636
Here is an example migration file:
3737

3838
```ts
39-
import { MigrateUpArgs, MigrateDownArgs } from '@payloadcms/your-db-adapter'
39+
import type { MigrateUpArgs, MigrateDownArgs } from '@payloadcms/your-db-adapter'
4040

4141
export async function up({ payload, req }: MigrateUpArgs): Promise<void> {
4242
// Perform changes to your database here.

Diff for: packages/db-mongodb/src/createMigration.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ import path from 'path'
55
import { getPredefinedMigration, writeMigrationIndex } from 'payload'
66
import { fileURLToPath } from 'url'
77

8-
const migrationTemplate = ({ downSQL, imports, upSQL }: MigrationTemplateArgs): string => `import {
8+
const migrationTemplate = ({
9+
downSQL,
10+
imports,
11+
upSQL,
12+
}: MigrationTemplateArgs): string => `import type {
913
MigrateDownArgs,
1014
MigrateUpArgs,
1115
} from '@payloadcms/db-mongodb'

Diff for: packages/drizzle/src/utilities/getMigrationTemplate.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export const getMigrationTemplate = ({
1111
imports,
1212
packageName,
1313
upSQL,
14-
}: MigrationTemplateArgs): string => `import { MigrateUpArgs, MigrateDownArgs, sql } from '${packageName}'
14+
}: MigrationTemplateArgs): string => `import { type MigrateUpArgs, type MigrateDownArgs, sql } from '${packageName}'
1515
${imports ? `${imports}\n` : ''}
1616
export async function up({ db, payload, req }: MigrateUpArgs): Promise<void> {
1717
${indent(upSQL)}

Diff for: packages/payload/src/database/migrations/migrationTemplate.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export const migrationTemplate = `
2-
import {
2+
import type {
33
MigrateUpArgs,
44
MigrateDownArgs,
55
} from "@payloadcms/db-mongodb";

0 commit comments

Comments
 (0)