site-panzai/node_modules/listhen/dist/cli.d.mts

173 lines
6.2 KiB
TypeScript
Raw Normal View History

2026-11-13 13:57:04 +01:00
import * as citty from 'citty';
import { ParsedArgs } from 'citty';
import { L as ListenOptions } from './shared/listhen.Dh3trXcM.mjs';
import 'node:http';
import 'node:https';
import 'node:net';
import 'get-port-please';
import 'crossws/adapters/node';
declare const main: citty.CommandDef<{
readonly port: {
readonly type: "string";
readonly description: "Port to listen on (use `PORT` environment variable to override)";
};
readonly host: {
readonly description: "Host to listen on. If no value or an empty string provided, will listen on all available interfaces (use `HOST` environment variable to override)";
};
readonly clipboard: {
readonly type: "boolean";
readonly description: "Copy the URL to the clipboard";
};
readonly open: {
readonly type: "boolean";
readonly description: "Open the URL in the browser";
};
readonly https: {
readonly type: "boolean";
readonly description: "Enable HTTPS";
};
readonly "https.cert": {
readonly type: "string";
readonly description: "Path to TLS certificate used with HTTPS in PEM format";
};
readonly "https.key": {
readonly type: "string";
readonly description: "Path to TLS key used with HTTPS in PEM format";
};
readonly "https.pfx": {
readonly type: "string";
readonly description: "Path to PKCS#12 (.p12/.pfx) keystore containing a TLS certificate and Key";
};
readonly "https.passphrase": {
readonly type: "string";
readonly description: "Passphrase used for TLS key or keystore";
};
readonly "https.validityDays": {
readonly type: "string";
readonly description: "Validity in days of the autogenerated TLS certificate (https: true)";
};
readonly "https.domains": {
readonly type: "string";
readonly description: "Comma separated list of domains and IPs, the autogenerated certificate should be valid for (https: true)";
};
readonly publicURL: {
readonly type: "string";
readonly description: "Displayed public URL (used for QR code)";
readonly required: false;
};
readonly qr: {
readonly type: "boolean";
readonly description: "Display The QR code of public URL when available";
readonly required: false;
};
readonly public: {
readonly type: "boolean";
readonly description: "Listen to all network interfaces";
readonly required: false;
};
readonly tunnel: {
readonly type: "boolean";
readonly description: "Open a tunnel using https://github.com/unjs/untun";
readonly required: false;
};
readonly cwd: {
readonly type: "string";
readonly description: "Current working directory";
};
readonly entry: {
readonly type: "positional";
readonly description: "Listener entry file (./app.ts)";
readonly required: true;
};
readonly name: {
readonly type: "string";
readonly description: "Name to use in the banner";
};
readonly baseURL: {
readonly type: "string";
readonly description: "Base URL to use";
};
readonly watch: {
readonly type: "boolean";
readonly description: "Watch for changes";
readonly alias: "w";
};
readonly ws: {
readonly type: "boolean";
readonly description: "Enable Experimental WebSocket support";
};
}>;
declare const runMain: () => Promise<void>;
/** Returns unjs/citty compatible args object */
declare function getArgs(): {
readonly port: {
readonly type: "string";
readonly description: "Port to listen on (use `PORT` environment variable to override)";
};
readonly host: {
readonly description: "Host to listen on. If no value or an empty string provided, will listen on all available interfaces (use `HOST` environment variable to override)";
};
readonly clipboard: {
readonly type: "boolean";
readonly description: "Copy the URL to the clipboard";
};
readonly open: {
readonly type: "boolean";
readonly description: "Open the URL in the browser";
};
readonly https: {
readonly type: "boolean";
readonly description: "Enable HTTPS";
};
readonly "https.cert": {
readonly type: "string";
readonly description: "Path to TLS certificate used with HTTPS in PEM format";
};
readonly "https.key": {
readonly type: "string";
readonly description: "Path to TLS key used with HTTPS in PEM format";
};
readonly "https.pfx": {
readonly type: "string";
readonly description: "Path to PKCS#12 (.p12/.pfx) keystore containing a TLS certificate and Key";
};
readonly "https.passphrase": {
readonly type: "string";
readonly description: "Passphrase used for TLS key or keystore";
};
readonly "https.validityDays": {
readonly type: "string";
readonly description: "Validity in days of the autogenerated TLS certificate (https: true)";
};
readonly "https.domains": {
readonly type: "string";
readonly description: "Comma separated list of domains and IPs, the autogenerated certificate should be valid for (https: true)";
};
readonly publicURL: {
readonly type: "string";
readonly description: "Displayed public URL (used for QR code)";
readonly required: false;
};
readonly qr: {
readonly type: "boolean";
readonly description: "Display The QR code of public URL when available";
readonly required: false;
};
readonly public: {
readonly type: "boolean";
readonly description: "Listen to all network interfaces";
readonly required: false;
};
readonly tunnel: {
readonly type: "boolean";
readonly description: "Open a tunnel using https://github.com/unjs/untun";
readonly required: false;
};
};
type ParsedListhenArgs = ParsedArgs<ReturnType<typeof getArgs>>;
/** Convert unjs/citty compatible args to listhen options */
declare function parseArgs(args: ParsedListhenArgs): Partial<ListenOptions>;
export { getArgs, main, parseArgs, runMain };