Skip to content

Commit

Permalink
Merge pull request #6 from prasadrajandran/development
Browse files Browse the repository at this point in the history 
1.0.1
  • Loading branch information
@prasadrajandran
prasadrajandran authored Jan 23, 2022
2 parents b5f0cc2 + 819acad commit 3e65b7e
Show file tree
Hide file tree
Showing 30 changed files with 1,770 additions and 3,095 deletions.
1 change: 0 additions & 1 deletion build.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ then
echo "(skipping) 4. build docs..."
else
echo "4. build docs..."
rm -r docs/
npm run build-docs
# Remove the first two lines from README file. The title is duplicated for
# some reason.
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# migr8 - v1.0.0
# migr8 - v1.0.1

## Table of contents

Expand Down
52 changes: 26 additions & 26 deletions docs/classes/migr8.Migr8.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[migr8 - v1.0.0](../README.md) / [migr8](../modules/migr8.md) / Migr8
[migr8 - v1.0.1](../README.md) / [migr8](../modules/migr8.md) / Migr8

# Class: Migr8

Expand Down Expand Up @@ -32,19 +32,19 @@

### constructor

• **new Migr8**(`__namedParameters?`)
• **new Migr8**(`arg?`)

Create a new Migr8 instance.

#### Parameters

| Name | Type |
| :------------------ | :----------------------------------------------------------------------------------- |
| `__namedParameters` | [`Migr8Constructor`](../interfaces/interfaces_migr8_constructor.Migr8Constructor.md) |
| Name | Type | Description |
| :---- | :----------------------------------------------------------------------------------- | :--------------- |
| `arg` | [`Migr8Constructor`](../interfaces/interfaces_migr8_constructor.Migr8Constructor.md) | Constructor arg. |

#### Defined in

[migr8.ts:79](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L79)
[migr8.ts:79](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L79)

## Properties

Expand All @@ -57,7 +57,7 @@ migrations when they are being rolledback.

#### Defined in

[migr8.ts:72](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L72)
[migr8.ts:72](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L72)

---

Expand All @@ -69,7 +69,7 @@ File encoding for the migration files.

#### Defined in

[migr8.ts:40](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L40)
[migr8.ts:40](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L40)

---

Expand All @@ -81,7 +81,7 @@ Absolute path to the folder housing the migrations.

#### Defined in

[migr8.ts:46](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L46)
[migr8.ts:46](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L46)

---

Expand All @@ -94,7 +94,7 @@ migrations.

#### Defined in

[migr8.ts:58](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L58)
[migr8.ts:58](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L58)

---

Expand All @@ -106,7 +106,7 @@ Absolute path to the template for new migrations.

#### Defined in

[migr8.ts:52](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L52)
[migr8.ts:52](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L52)

---

Expand All @@ -119,7 +119,7 @@ migrations when they are being migrated.

#### Defined in

[migr8.ts:65](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L65)
[migr8.ts:65](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L65)

## Methods

Expand All @@ -144,7 +144,7 @@ created.

#### Defined in

[migr8.ts:102](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L102)
[migr8.ts:102](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L102)

---

Expand All @@ -170,21 +170,21 @@ A promise that resolves to the generated filename.

#### Defined in

[migr8.ts:233](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L233)
[migr8.ts:233](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L233)

---

### down

▸ **down**(`__namedParameters?`): `Promise`<[`DownedMigrations`](../interfaces/interfaces_downed_migrations.DownedMigrations.md)\>
▸ **down**(`options?`): `Promise`<[`DownedMigrations`](../interfaces/interfaces_downed_migrations.DownedMigrations.md)\>

Roll back latest batch of executed migrations.

#### Parameters

| Name | Type |
| :------------------ | :------------ |
| `__namedParameters` | `DownOptions` |
| Name | Type | Description |
| :-------- | :------------ | :------------------------------- |
| `options` | `DownOptions` | Options to adjust the operation. |

#### Returns

Expand All @@ -194,7 +194,7 @@ Results of the rollback.

#### Defined in

[migr8.ts:179](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L179)
[migr8.ts:179](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L179)

---

Expand All @@ -212,7 +212,7 @@ Migration filenames (not including the path).

#### Defined in

[migr8.ts:256](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L256)
[migr8.ts:256](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L256)

---

Expand All @@ -230,21 +230,21 @@ Pending migration filenames (not including the path).

#### Defined in

[migr8.ts:270](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L270)
[migr8.ts:270](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L270)

---

### up

▸ **up**(`__namedParameters?`): `Promise`<[`UppedMigrations`](../interfaces/interfaces_upped_migrations.UppedMigrations.md)\>
▸ **up**(`options?`): `Promise`<[`UppedMigrations`](../interfaces/interfaces_upped_migrations.UppedMigrations.md)\>

Run pending migrations.

#### Parameters

| Name | Type |
| :------------------ | :---------- |
| `__namedParameters` | `UpOptions` |
| Name | Type | Description |
| :-------- | :---------- | :------------------------------- |
| `options` | `UpOptions` | Options to adjust the operation. |

#### Returns

Expand All @@ -254,4 +254,4 @@ Results of the migration.

#### Defined in

[migr8.ts:128](https://github.com/prasadrajandran/migr8/blob/5654936/src/migr8.ts#L128)
[migr8.ts:128](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/migr8.ts#L128)
28 changes: 14 additions & 14 deletions docs/classes/registry_drivers_file_system_registry.FileSystemRegistry.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[migr8 - v1.0.0](../README.md) / [registry_drivers/file_system_registry](../modules/registry_drivers_file_system_registry.md) / FileSystemRegistry
[migr8 - v1.0.1](../README.md) / [registry_drivers/file_system_registry](../modules/registry_drivers_file_system_registry.md) / FileSystemRegistry

# Class: FileSystemRegistry

Expand Down Expand Up @@ -28,19 +28,19 @@

### constructor

• **new FileSystemRegistry**(`__namedParameters?`)
• **new FileSystemRegistry**(`arg?`)

Construct a new File System Registry Driver.

#### Parameters

| Name | Type |
| :------------------ | :---------------------------------------------------------------------------------------------------------------------------- |
| `__namedParameters` | [`FileSystemRegistryConstructor`](../interfaces/interfaces_file_system_registry_constructor.FileSystemRegistryConstructor.md) |
| Name | Type | Description |
| :---- | :---------------------------------------------------------------------------------------------------------------------------- | :--------------- |
| `arg` | [`FileSystemRegistryConstructor`](../interfaces/interfaces_file_system_registry_constructor.FileSystemRegistryConstructor.md) | Constructor arg. |

#### Defined in

[registry_drivers/file_system_registry.ts:26](https://github.com/prasadrajandran/migr8/blob/5654936/src/registry_drivers/file_system_registry.ts#L26)
[registry_drivers/file_system_registry.ts:26](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/registry_drivers/file_system_registry.ts#L26)

## Properties

Expand All @@ -52,7 +52,7 @@ File encoding of the registry.

#### Defined in

[registry_drivers/file_system_registry.ts:14](https://github.com/prasadrajandran/migr8/blob/5654936/src/registry_drivers/file_system_registry.ts#L14)
[registry_drivers/file_system_registry.ts:14](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/registry_drivers/file_system_registry.ts#L14)

---

Expand All @@ -64,7 +64,7 @@ Filename (including the path) of the registry file.

#### Defined in

[registry_drivers/file_system_registry.ts:19](https://github.com/prasadrajandran/migr8/blob/5654936/src/registry_drivers/file_system_registry.ts#L19)
[registry_drivers/file_system_registry.ts:19](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/registry_drivers/file_system_registry.ts#L19)

## Methods

Expand All @@ -84,21 +84,21 @@ Get migrations that have been migrated.

#### Defined in

[registry_drivers/file_system_registry.ts:39](https://github.com/prasadrajandran/migr8/blob/5654936/src/registry_drivers/file_system_registry.ts#L39)
[registry_drivers/file_system_registry.ts:39](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/registry_drivers/file_system_registry.ts#L39)

---

### setExecutedMigrations

▸ **setExecutedMigrations**(`__namedParameters`): `Promise`<`void`\>
▸ **setExecutedMigrations**(`update`): `Promise`<`void`\>

Set executed migrations.

#### Parameters

| Name | Type |
| :------------------ | :----------------------------------------------------------------------------- |
| `__namedParameters` | [`RegistryUpdate`](../interfaces/interfaces_registry_update.RegistryUpdate.md) |
| Name | Type | Description |
| :------- | :----------------------------------------------------------------------------- | :--------------- |
| `update` | [`RegistryUpdate`](../interfaces/interfaces_registry_update.RegistryUpdate.md) | Updated details. |

#### Returns

Expand All @@ -110,4 +110,4 @@ Set executed migrations.

#### Defined in

[registry_drivers/file_system_registry.ts:56](https://github.com/prasadrajandran/migr8/blob/5654936/src/registry_drivers/file_system_registry.ts#L56)
[registry_drivers/file_system_registry.ts:56](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/registry_drivers/file_system_registry.ts#L56)
4 changes: 2 additions & 2 deletions docs/interfaces/interfaces_down_arg.DownArg.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[migr8 - v1.0.0](../README.md) / [interfaces/down_arg](../modules/interfaces_down_arg.md) / DownArg
[migr8 - v1.0.1](../README.md) / [interfaces/down_arg](../modules/interfaces_down_arg.md) / DownArg

# Interface: DownArg

Expand All @@ -18,4 +18,4 @@ Resolves to a value that will be passed to `Migr8.down()`.

#### Defined in

[interfaces/down_arg.ts:5](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/down_arg.ts#L5)
[interfaces/down_arg.ts:5](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/down_arg.ts#L5)
6 changes: 3 additions & 3 deletions docs/interfaces/interfaces_downed_migrations.DownedMigrations.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[migr8 - v1.0.0](../README.md) / [interfaces/downed_migrations](../modules/interfaces_downed_migrations.md) / DownedMigrations
[migr8 - v1.0.1](../README.md) / [interfaces/downed_migrations](../modules/interfaces_downed_migrations.md) / DownedMigrations

# Interface: DownedMigrations

Expand All @@ -21,7 +21,7 @@ Reference to the Error if an error occured.

#### Defined in

[interfaces/downed_migrations.ts:12](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/downed_migrations.ts#L12)
[interfaces/downed_migrations.ts:12](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/downed_migrations.ts#L12)

---

Expand All @@ -33,4 +33,4 @@ Migrations that were rolled back.

#### Defined in

[interfaces/downed_migrations.ts:7](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/downed_migrations.ts#L7)
[interfaces/downed_migrations.ts:7](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/downed_migrations.ts#L7)
8 changes: 4 additions & 4 deletions docs/interfaces/interfaces_executed_migration.ExecutedMigration.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[migr8 - v1.0.0](../README.md) / [interfaces/executed_migration](../modules/interfaces_executed_migration.md) / ExecutedMigration
[migr8 - v1.0.1](../README.md) / [interfaces/executed_migration](../modules/interfaces_executed_migration.md) / ExecutedMigration

# Interface: ExecutedMigration

Expand All @@ -22,7 +22,7 @@ Batch the executed migration belongs to.

#### Defined in

[interfaces/executed_migration.ts:10](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/executed_migration.ts#L10)
[interfaces/executed_migration.ts:10](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/executed_migration.ts#L10)

---

Expand All @@ -34,7 +34,7 @@ Unix timestamp of when the migration was executed.

#### Defined in

[interfaces/executed_migration.ts:15](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/executed_migration.ts#L15)
[interfaces/executed_migration.ts:15](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/executed_migration.ts#L15)

---

Expand All @@ -46,4 +46,4 @@ Name of the migration.

#### Defined in

[interfaces/executed_migration.ts:5](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/executed_migration.ts#L5)
[interfaces/executed_migration.ts:5](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/executed_migration.ts#L5)
6 changes: 3 additions & 3 deletions ...es/interfaces_file_system_registry_constructor.FileSystemRegistryConstructor.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[migr8 - v1.0.0](../README.md) / [interfaces/file_system_registry_constructor](../modules/interfaces_file_system_registry_constructor.md) / FileSystemRegistryConstructor
[migr8 - v1.0.1](../README.md) / [interfaces/file_system_registry_constructor](../modules/interfaces_file_system_registry_constructor.md) / FileSystemRegistryConstructor

# Interface: FileSystemRegistryConstructor

Expand All @@ -22,7 +22,7 @@ directory.

#### Defined in

[interfaces/file_system_registry_constructor.ts:6](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/file_system_registry_constructor.ts#L6)
[interfaces/file_system_registry_constructor.ts:6](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/file_system_registry_constructor.ts#L6)

---

Expand All @@ -35,4 +35,4 @@ Filename (not including the path) of the registry file. Defaults to

#### Defined in

[interfaces/file_system_registry_constructor.ts:12](https://github.com/prasadrajandran/migr8/blob/5654936/src/interfaces/file_system_registry_constructor.ts#L12)
[interfaces/file_system_registry_constructor.ts:12](https://github.com/prasadrajandran/migr8/blob/b5f0cc2/src/interfaces/file_system_registry_constructor.ts#L12)
Loading

0 comments on commit 3e65b7e

Please sign in to comment.