Skip to content

Commit

Permalink
Fix incorrect typings of triggers in keepFresh
Browse files Browse the repository at this point in the history
  • Loading branch information
igorkamyshev committed May 11, 2023
1 parent 45ed2aa commit 461fbc8
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/spicy-wasps-cry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@farfetched/core': patch
---

Fix incorrect typings of `triggers` in `keepFresh`
11 changes: 11 additions & 0 deletions packages/core/src/trigger_api/__test__/keep_fresh.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { Event } from 'effector';
import { describe, test } from 'vitest';

import { Query } from '../../query/type';
Expand All @@ -11,4 +12,14 @@ describe('keepFresh', () => {
keepFresh(q, { triggers: [] });
keepFresh(q, { automatically: true, triggers: [] });
});

test('supports any Event as trigger', () => {
const q = {} as unknown as Query<number, string, string>;

const voidEvent = {} as unknown as Event<void>;
const stringEvent = {} as unknown as Event<string>;

keepFresh(q, { triggers: [stringEvent, voidEvent] });
keepFresh(q, { automatically: true, triggers: [stringEvent, voidEvent] });
});
});
4 changes: 2 additions & 2 deletions packages/core/src/trigger_api/keep_fresh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ export function keepFresh<Params>(
export function keepFresh<Params>(
query: Query<Params, any, any, any>,
config: {
triggers: Array<Event<unknown> | Event<void> | TriggerProtocol>;
triggers: Array<Event<unknown> | Event<any> | TriggerProtocol>;
}
): void;

export function keepFresh<Params>(
query: Query<Params, any, any, any>,
config: {
automatically: true;
triggers: Array<Event<unknown> | Event<void> | TriggerProtocol>;
triggers: Array<Event<unknown> | Event<any> | TriggerProtocol>;
}
): void;

Expand Down

0 comments on commit 461fbc8

Please sign in to comment.