fix: make types allow { to: 0 } (#223)

Author: mmkal

package-lock.json

@@ -44,7 +44,7 @@
 		"sqlite3": "^4.1.1",
 		"ts-jest": "^25.4.0",
 		"type-fest": "^0.13.0",
-		"typescript": "~3.8.3",
+		"typescript": "~3.9.2",
 		"uuid": "^7.0.2"
 	},
 	"scripts": {

package.json

@@ -145,5 +145,5 @@ export type UmzugRunOptions =
 			from?: string;
 
 			/** The last migration to execute (included). */
-			to?: string;
+			to?: string | 0;
 	  };

src/types.ts

@@ -177,7 +177,7 @@ export class Umzug extends EventEmitter {
 	If `from` is omitted, takes from the beginning.
 	If `to` is omitted, takes to the end.
 	*/
-	async up(options: { from?: string; to?: string }): Promise<Migration[]>;
+	async up(options: { from?: string; to?: string | 0 }): Promise<Migration[]>;
 
 	async up(options?: UmzugRunOptions): Promise<Migration[]> {
 		return this._run('up', options, this.pending.bind(this));
@@ -204,7 +204,7 @@ export class Umzug extends EventEmitter {
 	If `from` is omitted, takes from the beginning.
 	If `to` is omitted, takes to the end.
 	*/
-	async down(options: { from?: string; to?: string }): Promise<Migration[]>;
+	async down(options: { from?: string; to?: string | 0 }): Promise<Migration[]>;
 
 	async down(options?: UmzugRunOptions): Promise<Migration[]> {
 		const getReversedExecuted = async () => {
@@ -396,7 +396,7 @@ export class Umzug extends EventEmitter {
 	/**
 	Skip migrations in a given migration list after `to` migration.
 	*/
-	private async _findMigrationsUntilMatch(to?: string, migrations?: Migration[]): Promise<string[]> {
+	private async _findMigrationsUntilMatch(to?: string | 0, migrations?: Migration[]): Promise<string[]> {
 		if (!Array.isArray(migrations)) {
 			migrations = [migrations];
 		}

src/umzug.ts

@@ -1,5 +1,6 @@
 import { Umzug, Migration, migrationsList, memoryStorage } from '../src';
 import pkgDir = require('pkg-dir');
+import { expectTypeOf } from 'expect-type';
 
 test('Compiles & exports correctly', async () => {
 	const dir = await pkgDir(__dirname);
@@ -15,6 +16,29 @@ test('Compiles & exports correctly', async () => {
 	expect(requiredJS.migrationsList).toBeTruthy();
 });
 
+test('type', () => {
+	expectTypeOf(Umzug).toBeConstructibleWith();
+	expectTypeOf(Umzug).toBeConstructibleWith({ storage: memoryStorage() });
+	expectTypeOf(Umzug).toBeConstructibleWith({ logging: false });
+	expectTypeOf(Umzug).toBeConstructibleWith({ logging: console.log });
+	expectTypeOf(Umzug).toBeConstructibleWith({ migrationSorting: (a, b) => a.localeCompare(b) });
+	expectTypeOf(Umzug).toBeConstructibleWith({ migrations: { path: 'test/abc' } });
+
+	expectTypeOf(Umzug).instance.toHaveProperty('up').toBeCallableWith({ to: 'migration123' });
+	expectTypeOf(Umzug).instance.toHaveProperty('up').toBeCallableWith({ to: 0 });
+
+	expectTypeOf(Umzug).instance.toHaveProperty('down').toBeCallableWith({ to: 'migration123' });
+	expectTypeOf(Umzug).instance.toHaveProperty('down').toBeCallableWith({ to: 0 });
+
+	// `{ to: 0 }` is a special case. `{ to: 1 }` shouldn't be allowed:
+
+	// @ts-expect-error
+	expectTypeOf(Umzug).instance.toHaveProperty('up').toBeCallableWith({ to: 1 });
+
+	// @ts-expect-error
+	expectTypeOf(Umzug).instance.toHaveProperty('down').toBeCallableWith({ to: 1 });
+});
+
 test('migrationsList() works', async () => {
 	const executed = [];