1
Fork 0

Compare commits

..

No commits in common. "43c3a5c13242eab252ce0f6b98c8e901383222fd" and "b798e18a162c21aaf7a639b5ade8bed31ec68490" have entirely different histories.

7 changed files with 15 additions and 7 deletions

View File

@ -8,6 +8,14 @@
* 100% code coverage. * 100% code coverage.
* TypeScript definitions included. * 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 ## Usage
```ts ```ts

View File

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

View File

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

View File

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

View File

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

View File

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