Skip to content
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.

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

To allow the possibility of adding a JavaScript object as a value in a select value #171

Open
fa11erX opened this issue Sep 29, 2023 · 1 comment

Comments

@fa11erX
Copy link

fa11erX commented Sep 29, 2023

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch @clack/prompts@0.7.0 for the project I'm working on.

Here is the diff that solved my problem:

diff --git a/node_modules/@clack/prompts/dist/index.d.ts b/node_modules/@clack/prompts/dist/index.d.ts
index e03f8d0..13e9fc1 100644
--- a/node_modules/@clack/prompts/dist/index.d.ts
+++ b/node_modules/@clack/prompts/dist/index.d.ts
@@ -23,11 +23,11 @@ interface ConfirmOptions {
 declare const confirm: (opts: ConfirmOptions) => Promise<boolean | symbol>;
 type Primitive = Readonly<string | boolean | number>;
 type Option<Value> = Value extends Primitive ? {
-    value: Value;
+    value: Value | object;
     label?: string;
     hint?: string;
 } : {
-    value: Value;
+    value: Value | object;
     label: string;
     hint?: string;
 };

This issue body was partially generated by patch-package.

@MacFJA
Copy link

MacFJA commented Mar 14, 2025

You can already do that:

type MyData = {
  foo: string,
  bar: number
};
const selection = p.select<MyData>({
  message: 'Select a Data',
  options: [{
    label: 'Data #1',
    value: {
      foo: 'hello',
      bar: 'world',
    }
  }, {
    label: 'Data #2',
    hint: 'In French',
    value: {
      foo: 'bonjour',
      bar: 'le monde',
    },
  }]
})

The result will be of type MyData


Available since @clack/prompts@0.6.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs triage
Development

No branches or pull requests

2 participants