Skip to content

Commit 9bcb76b

Browse files
committed
test/types fix
1 parent c34ea88 commit 9bcb76b

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

packages/cli-kit/src/public/node/ui.test.ts

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -425,11 +425,11 @@ describe('renderSingleTask', async () => {
425425
test('returns promise result when task resolves successfully', async () => {
426426
// Given
427427
const expectedResult = {id: 123, name: 'test-result'}
428-
const taskPromise = Promise.resolve(expectedResult)
428+
const task = () => Promise.resolve(expectedResult)
429429
const title = 'Processing data'
430430

431431
// When
432-
const result = await renderSingleTask({title, taskPromise})
432+
const result = await renderSingleTask({title, task})
433433

434434
// Then
435435
expect(result).toEqual(expectedResult)
@@ -438,23 +438,23 @@ describe('renderSingleTask', async () => {
438438
test('returns function result when function resolves successfully', async () => {
439439
// Given
440440
const expectedResult = {id: 123, name: 'test-result'}
441-
const taskPromise = () => Promise.resolve(expectedResult)
441+
const task = () => Promise.resolve(expectedResult)
442442
const title = 'Processing data'
443443

444444
// When
445-
const result = await renderSingleTask({title, taskPromise})
445+
const result = await renderSingleTask({title, task})
446446

447447
// Then
448448
expect(result).toEqual(expectedResult)
449449
})
450450

451451
test('returns undefined when task resolves with undefined', async () => {
452452
// Given
453-
const taskPromise = Promise.resolve(undefined)
453+
const task = () => Promise.resolve(undefined)
454454
const title = 'Void task'
455455

456456
// When
457-
const result = await renderSingleTask({title, taskPromise})
457+
const result = await renderSingleTask({title, task})
458458

459459
// Then
460460
expect(result).toBeUndefined()
@@ -463,36 +463,37 @@ describe('renderSingleTask', async () => {
463463
test('throws error when task promise rejects', async () => {
464464
// Given
465465
const expectedError = new Error('Task failed with error')
466-
const taskPromise = Promise.reject(expectedError)
466+
const task = () => Promise.reject(expectedError)
467467
const title = 'Failing task'
468468

469469
// When & Then
470-
await expect(renderSingleTask({title, taskPromise})).rejects.toThrow('Task failed with error')
470+
await expect(renderSingleTask({title, task})).rejects.toThrow('Task failed with error')
471471
})
472472

473473
test('handles slow promise rejection', async () => {
474474
// Given
475475
const expectedError = new Error('Delayed failure')
476-
const taskPromise = new Promise((resolve, reject) => {
477-
setTimeout(() => reject(expectedError), 100)
478-
})
476+
const task = () =>
477+
new Promise((resolve, reject) => {
478+
setTimeout(() => reject(expectedError), 100)
479+
})
479480
const title = 'Slow failing task'
480481

481482
// When & Then
482-
await expect(renderSingleTask({title, taskPromise})).rejects.toThrow('Delayed failure')
483+
await expect(renderSingleTask({title, task})).rejects.toThrow('Delayed failure')
483484
})
484485

485486
test('handles concurrent single tasks', async () => {
486487
// Given
487-
const task1Promise = new Promise((resolve) => setTimeout(() => resolve('result1'), 50))
488-
const task2Promise = new Promise((resolve) => setTimeout(() => resolve('result2'), 100))
489-
const task3Promise = new Promise((resolve) => setTimeout(() => resolve('result3'), 25))
488+
const task1 = () => new Promise((resolve) => setTimeout(() => resolve('result1'), 50))
489+
const task2 = () => new Promise((resolve) => setTimeout(() => resolve('result2'), 100))
490+
const task3 = () => new Promise((resolve) => setTimeout(() => resolve('result3'), 25))
490491

491492
// When
492493
const [result1, result2, result3] = await Promise.all([
493-
renderSingleTask({title: 'Task 1', taskPromise: task1Promise}),
494-
renderSingleTask({title: 'Task 2', taskPromise: task2Promise}),
495-
renderSingleTask({title: 'Task 3', taskPromise: task3Promise}),
494+
renderSingleTask({title: 'Task 1', task: task1}),
495+
renderSingleTask({title: 'Task 2', task: task2}),
496+
renderSingleTask({title: 'Task 3', task: task3}),
496497
])
497498

498499
// Then

packages/cli-kit/src/public/node/ui.tsx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,9 +495,10 @@ export interface RenderSingleTaskOptions<T> {
495495

496496
/**
497497
* Awaits a single task and displays a loading bar while it's in progress. The task's result is returned.
498-
* @param title - The initial title to display with the loading bar
499-
* @param task - The async task to execute. Receives an updateStatus callback to change the displayed title.
500-
* @param renderOptions - Optional render configuration
498+
* @param options - Configuration object
499+
* @param options.title - The initial title to display with the loading bar
500+
* @param options.task - The async task to execute. Receives an updateStatus callback to change the displayed title.
501+
* @param options.renderOptions - Optional render configuration
501502
* @returns The result of the task
502503
* @example
503504
* ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀

0 commit comments

Comments
 (0)