Skip to content

fix: weaken internal group types to strengthen return/onCancel types #245

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: weaken internal group types to strengthen return/onCancel types #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 3 additions & 7 deletions packages/prompts/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,16 +844,12 @@ export const spinner = ({ indicator = 'dots' }: SpinnerOptions = {}) => {
};
};

export type PromptGroupAwaitedReturn<T> = {
[P in keyof T]: Exclude<Awaited<T[P]>, symbol>;
};

export interface PromptGroupOptions<T> {
/**
* Control how the group can be canceled
* if one of the prompts is canceled.
*/
onCancel?: (opts: { results: Prettify<Partial<PromptGroupAwaitedReturn<T>>> }) => void;
onCancel?: (opts: { results: Prettify<Partial<T>> }) => void;
}

type Prettify<T> = {
Expand All @@ -862,7 +858,7 @@ type Prettify<T> = {

export type PromptGroup<T> = {
[P in keyof T]: (opts: {
results: Prettify<Partial<PromptGroupAwaitedReturn<Omit<T, P>>>>;
results: Record<PropertyKey, unknown>;
}) => undefined | Promise<T[P] | undefined>;
};

Expand All @@ -873,7 +869,7 @@ export type PromptGroup<T> = {
export const group = async <T>(
prompts: PromptGroup<T>,
opts?: PromptGroupOptions<T>
): Promise<Prettify<PromptGroupAwaitedReturn<T>>> => {
): Promise<Prettify<T>> => {
const results = {} as any;
const promptNames = Object.keys(prompts);

Expand Down