1
Fork 0

Compare commits

...

3 Commits

Author SHA1 Message Date
Bauke 43c3a5c132
Version 0.1.4! 2023-05-08 12:26:29 +02:00
Bauke fd20d051a1
Remove custom registry instructions. 2023-05-08 12:25:57 +02:00
Bauke 7c95c574ce
Add A and B types to Migration. 2023-05-08 12:24:58 +02:00
7 changed files with 7 additions and 15 deletions

View File

@ -8,14 +8,6 @@
* 100% code coverage.
* TypeScript definitions included.
## Registry Setup
To use this package, add a registry for the `@holllo` scope to your npm configuration.
```
npm config set @holllo:registry https://git.bauke.xyz/api/packages/Holllo/npm/
```
## Usage
```ts

View File

@ -2,7 +2,7 @@
"name": "@holllo/migration-helper",
"description": "Tiny helper library for migrating data.",
"license": "AGPL-3.0-or-later",
"version": "0.1.3",
"version": "0.1.4",
"author": "Holllo <helllo@holllo.org>",
"repository": {
"type": "git",

View File

@ -7,9 +7,9 @@
* The migrate function should take the data you pass through {@link migrate}
* and modify it to your needs.
*/
export type Migration<V> = {
export type Migration<V, A = any, B = any> = {
version: V;
migrate: (data: any) => Promise<unknown>;
migrate: (data: A) => Promise<B>;
};
/**

View File

@ -3,7 +3,7 @@ import test from 'ava';
import {migrate, Migration} from '../source/migration-helper.js';
test('migrate<Date>', async (t) => {
const migrations: Array<Migration<Date>> = [
const migrations: Array<Migration<Date, string, string>> = [
{
version: new Date('2022-01-01'),
migrate: async (data: string) => `${data} migrated`,

View File

@ -3,7 +3,7 @@ import test from 'ava';
import {migrate, Migration} from '../source/migration-helper.js';
test('migrate<number>', async (t) => {
const migrations: Array<Migration<number>> = [
const migrations: Array<Migration<number, string, string>> = [
{
version: 5,
migrate: async (data: string) => `${data} migrated`,

View File

@ -12,7 +12,7 @@ test('migrate<{custom: number}>', async (t) => {
};
const skip: SkipMigrationFn<Custom> = (a, b) => a.custom > b.custom;
const migrations: Array<Migration<Custom>> = [
const migrations: Array<Migration<Custom, string, string>> = [
{
version: {custom: 5},
migrate: async (data: string) => `${data} migrated`,

View File

@ -3,7 +3,7 @@ import test from 'ava';
import {migrate, Migration} from '../source/migration-helper.js';
test('migrate<string>', async (t) => {
const migrations: Array<Migration<string>> = [
const migrations: Array<Migration<string, string, string>> = [
{
version: '0.2.4',
migrate: async (data: string) => `${data} migrated`,