Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[labs/task] Disambiguate TaskFunction type #4161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
augustjk merged 3 commits into from
Aug 30, 2023
Merged

[labs/task] Disambiguate TaskFunction type #4161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92a3aae
Disambiguate TaskFunction type
augustjk Aug 30, 2023
e69c73a
Add changeset
augustjk Aug 30, 2023
2c6d31b
Add type inference test
augustjk Aug 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gentle-needles-perform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@lit-labs/task': patch
---

Disambiguate `TypeFunction` type to fix type error when providing a task function making use of the abort signal.
4 changes: 2 additions & 2 deletions packages/labs/task/src/task.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import {notEqual} from '@lit/reactive-element';
import {ReactiveControllerHost} from '@lit/reactive-element/reactive-controller.js';

export interface TaskFunctionOptions {
signal?: AbortSignal;
signal: AbortSignal;
}

export type TaskFunction<D extends ReadonlyArray<unknown>, R = unknown> = (
args: D,
options?: TaskFunctionOptions
options: TaskFunctionOptions
) => R | typeof initialState | Promise<R | typeof initialState>;
export type ArgsFunction<D extends ReadonlyArray<unknown>> = () => D;

Expand Down
12 changes: 12 additions & 0 deletions packages/labs/task/src/test/task_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,18 @@ suite('Task', () => {
};
});

test('task functions can infer type of option param', () => {
return class MyElement extends ReactiveElement {
task = new Task(
this,
// Second param should get inferred to `TaskFunctionOptions` with an
// `AbortSignal`
([a], {signal}) => (signal.throwIfAborted(), a),
() => [1]
);
};
});

test('onComplete callback is called', async () => {
let numOnCompleteInvocations = 0;
let lastOnCompleteResult: string | undefined = undefined;
Expand Down