@modern-js/utils 2.12.1-alpha.0 → 2.12.1-alpha.2

package/dist/types/compiled/mime-types/license

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
+Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/types/compiled/mime-types/package.json

@@ -0,0 +1 @@
+{"name":"mime-types","version":"2.1.35","license":"MIT"}

package/dist/types/compiled/minimist/index.d.ts

@@ -0,0 +1,95 @@
+// Type definitions for minimist 1.2
+// Project: https://github.com/substack/minimist
+// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
+//                 Necroskillz <https://github.com/Necroskillz>
+//                 kamranayub <https://github.com/kamranayub>
+//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/**
+ * Return an argument object populated with the array arguments from args
+ *
+ * @param [args] An optional argument array (typically `process.argv.slice(2)`)
+ * @param [opts] An optional options object to customize the parsing
+ */
+declare function minimist(args?: string[], opts?: minimist.Opts): minimist.ParsedArgs;
+
+/**
+ * Return an argument object populated with the array arguments from args. Strongly-typed
+ * to be the intersect of type T with minimist.ParsedArgs.
+ *
+ * `T` The type that will be intersected with minimist.ParsedArgs to represent the argument object
+ *
+ * @param [args] An optional argument array (typically `process.argv.slice(2)`)
+ * @param [opts] An optional options object to customize the parsing
+ */
+declare function minimist<T>(args?: string[], opts?: minimist.Opts): T & minimist.ParsedArgs;
+
+/**
+ * Return an argument object populated with the array arguments from args. Strongly-typed
+ * to be the the type T which should extend minimist.ParsedArgs
+ *
+ * `T` The type that extends minimist.ParsedArgs and represents the argument object
+ *
+ * @param [args] An optional argument array (typically `process.argv.slice(2)`)
+ * @param [opts] An optional options object to customize the parsing
+ */
+declare function minimist<T extends minimist.ParsedArgs>(args?: string[], opts?: minimist.Opts): T;
+
+declare namespace minimist {
+    interface Opts {
+        /**
+         * A string or array of strings argument names to always treat as strings
+         */
+        string?: string | string[] | undefined;
+
+        /**
+         * A boolean, string or array of strings to always treat as booleans. If true will treat
+         * all double hyphenated arguments without equals signs as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`)
+         */
+        boolean?: boolean | string | string[] | undefined;
+
+        /**
+         * An object mapping string names to strings or arrays of string argument names to use as aliases
+         */
+        alias?: { [key: string]: string | string[] } | undefined;
+
+        /**
+         * An object mapping string argument names to default values
+         */
+        default?: { [key: string]: any } | undefined;
+
+        /**
+         * When true, populate argv._ with everything after the first non-option
+         */
+        stopEarly?: boolean | undefined;
+
+        /**
+         * A function which is invoked with a command line parameter not defined in the opts
+         * configuration object. If the function returns false, the unknown option is not added to argv
+         */
+        unknown?: ((arg: string) => boolean) | undefined;
+
+        /**
+         * When true, populate argv._ with everything before the -- and argv['--'] with everything after the --.
+         * Note that with -- set, parsing for arguments still stops after the `--`.
+         */
+        '--'?: boolean | undefined;
+    }
+
+    interface ParsedArgs {
+        [arg: string]: any;
+
+        /**
+         * If opts['--'] is true, populated with everything after the --
+         */
+        '--'?: string[] | undefined;
+
+        /**
+         * Contains all the arguments that didn't have an option associated with them
+         */
+        _: string[];
+    }
+}
+
+export = minimist;

package/dist/types/compiled/minimist/index.js

@@ -0,0 +1 @@
+(()=>{var e={319:e=>{e.exports=function(e,t){if(!t)t={};var r={bools:{},strings:{},unknownFn:null};if(typeof t["unknown"]==="function"){r.unknownFn=t["unknown"]}if(typeof t["boolean"]==="boolean"&&t["boolean"]){r.allBools=true}else{[].concat(t["boolean"]).filter(Boolean).forEach((function(e){r.bools[e]=true}))}var n={};Object.keys(t.alias||{}).forEach((function(e){n[e]=[].concat(t.alias[e]);n[e].forEach((function(t){n[t]=[e].concat(n[e].filter((function(e){return t!==e})))}))}));[].concat(t.string).filter(Boolean).forEach((function(e){r.strings[e]=true;if(n[e]){r.strings[n[e]]=true}}));var o=t["default"]||{};var s={_:[]};Object.keys(r.bools).forEach((function(e){setArg(e,o[e]===undefined?false:o[e])}));var i=[];if(e.indexOf("--")!==-1){i=e.slice(e.indexOf("--")+1);e=e.slice(0,e.indexOf("--"))}function argDefined(e,t){return r.allBools&&/^--[^=]+$/.test(t)||r.strings[e]||r.bools[e]||n[e]}function setArg(e,t,o){if(o&&r.unknownFn&&!argDefined(e,o)){if(r.unknownFn(o)===false)return}var i=!r.strings[e]&&isNumber(t)?Number(t):t;setKey(s,e.split("."),i);(n[e]||[]).forEach((function(e){setKey(s,e.split("."),i)}))}function setKey(e,t,n){var o=e;for(var s=0;s<t.length-1;s++){var i=t[s];if(isConstructorOrProto(o,i))return;if(o[i]===undefined)o[i]={};if(o[i]===Object.prototype||o[i]===Number.prototype||o[i]===String.prototype)o[i]={};if(o[i]===Array.prototype)o[i]=[];o=o[i]}var i=t[t.length-1];if(isConstructorOrProto(o,i))return;if(o===Object.prototype||o===Number.prototype||o===String.prototype)o={};if(o===Array.prototype)o=[];if(o[i]===undefined||r.bools[i]||typeof o[i]==="boolean"){o[i]=n}else if(Array.isArray(o[i])){o[i].push(n)}else{o[i]=[o[i],n]}}function aliasIsBoolean(e){return n[e].some((function(e){return r.bools[e]}))}for(var a=0;a<e.length;a++){var f=e[a];if(/^--.+=/.test(f)){var u=f.match(/^--([^=]+)=([\s\S]*)$/);var l=u[1];var c=u[2];if(r.bools[l]){c=c!=="false"}setArg(l,c,f)}else if(/^--no-.+/.test(f)){var l=f.match(/^--no-(.+)/)[1];setArg(l,false,f)}else if(/^--.+/.test(f)){var l=f.match(/^--(.+)/)[1];var p=e[a+1];if(p!==undefined&&!/^-/.test(p)&&!r.bools[l]&&!r.allBools&&(n[l]?!aliasIsBoolean(l):true)){setArg(l,p,f);a++}else if(/^(true|false)$/.test(p)){setArg(l,p==="true",f);a++}else{setArg(l,r.strings[l]?"":true,f)}}else if(/^-[^-]+/.test(f)){var b=f.slice(1,-1).split("");var _=false;for(var g=0;g<b.length;g++){var p=f.slice(g+2);if(p==="-"){setArg(b[g],p,f);continue}if(/[A-Za-z]/.test(b[g])&&/=/.test(p)){setArg(b[g],p.split("=")[1],f);_=true;break}if(/[A-Za-z]/.test(b[g])&&/-?\d+(\.\d*)?(e-?\d+)?$/.test(p)){setArg(b[g],p,f);_=true;break}if(b[g+1]&&b[g+1].match(/\W/)){setArg(b[g],f.slice(g+2),f);_=true;break}else{setArg(b[g],r.strings[b[g]]?"":true,f)}}var l=f.slice(-1)[0];if(!_&&l!=="-"){if(e[a+1]&&!/^(-|--)[^-]/.test(e[a+1])&&!r.bools[l]&&(n[l]?!aliasIsBoolean(l):true)){setArg(l,e[a+1],f);a++}else if(e[a+1]&&/^(true|false)$/.test(e[a+1])){setArg(l,e[a+1]==="true",f);a++}else{setArg(l,r.strings[l]?"":true,f)}}}else{if(!r.unknownFn||r.unknownFn(f)!==false){s._.push(r.strings["_"]||!isNumber(f)?f:Number(f))}if(t.stopEarly){s._.push.apply(s._,e.slice(a+1));break}}}Object.keys(o).forEach((function(e){if(!hasKey(s,e.split("."))){setKey(s,e.split("."),o[e]);(n[e]||[]).forEach((function(t){setKey(s,t.split("."),o[e])}))}}));if(t["--"]){s["--"]=new Array;i.forEach((function(e){s["--"].push(e)}))}else{i.forEach((function(e){s._.push(e)}))}return s};function hasKey(e,t){var r=e;t.slice(0,-1).forEach((function(e){r=r[e]||{}}));var n=t[t.length-1];return n in r}function isNumber(e){if(typeof e==="number")return true;if(/^0x[0-9a-f]+$/i.test(e))return true;return/^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/.test(e)}function isConstructorOrProto(e,t){return t==="constructor"&&typeof e[t]==="function"||t==="__proto__"}}};var t={};function __nccwpck_require__(r){var n=t[r];if(n!==undefined){return n.exports}var o=t[r]={exports:{}};var s=true;try{e[r](o,o.exports,__nccwpck_require__);s=false}finally{if(s)delete t[r]}return o.exports}if(typeof __nccwpck_require__!=="undefined")__nccwpck_require__.ab=__dirname+"/";var r=__nccwpck_require__(319);module.exports=r})();

package/dist/types/compiled/minimist/license

@@ -0,0 +1,18 @@
+This software is released under the MIT license:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/types/compiled/minimist/package.json

@@ -0,0 +1 @@
+{"name":"minimist","author":{"name":"James Halliday","email":"mail@substack.net","url":"http://substack.net"},"version":"1.2.6","license":"MIT"}

package/dist/types/compiled/nanoid/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Generate secure URL-friendly unique ID.
+ *
+ * By default, the ID will have 21 symbols to have a collision probability
+ * similar to UUID v4.
+ *
+ * ```js
+ * import { nanoid } from './nanoid'
+ * model.id = nanoid() //=> "Uakgb_J5m9g-0JDMbcJqL"
+ * ```
+ *
+ * @param size Size of the ID. The default size is 21.
+ * @returns A random string.
+ */
+export function nanoid(size?: number): string
+
+/**
+ * Generate secure unique ID with custom alphabet.
+ *
+ * Alphabet must contain 256 symbols or less. Otherwise, the generator
+ * will not be secure.
+ *
+ * @param alphabet Alphabet used to generate the ID.
+ * @param defaultSize Size of the ID. The default size is 21.
+ * @returns A random string generator.
+ *
+ * ```js
+ * const { customAlphabet } = require('nanoid')
+ * const nanoid = customAlphabet('0123456789абвгдеё', 5)
+ * nanoid() //=> "8ё56а"
+ * ```
+ */
+export function customAlphabet(
+  alphabet: string,
+  defaultSize?: number
+): (size?: number) => string
+
+/**
+ * Generate unique ID with custom random generator and alphabet.
+ *
+ * Alphabet must contain 256 symbols or less. Otherwise, the generator
+ * will not be secure.
+ *
+ * ```js
+ * import { customRandom } from './nanoid/format'
+ *
+ * const nanoid = customRandom('abcdef', 5, size => {
+ *   const random = []
+ *   for (let i = 0; i < size; i++) {
+ *     random.push(randomByte())
+ *   }
+ *   return random
+ * })
+ *
+ * nanoid() //=> "fbaef"
+ * ```
+ *
+ * @param alphabet Alphabet used to generate a random string.
+ * @param size Size of the random string.
+ * @param random A random bytes generator.
+ * @returns A random string generator.
+ */
+export function customRandom(
+  alphabet: string,
+  size: number,
+  random: (bytes: number) => Uint8Array
+): () => string
+
+/**
+ * URL safe symbols.
+ *
+ * ```js
+ * import { urlAlphabet } from './nanoid'
+ * const nanoid = customAlphabet(urlAlphabet, 10)
+ * nanoid() //=> "Uakgb_J5m9"
+ * ```
+ */
+export const urlAlphabet: string
+
+/**
+ * Generate an array of random bytes collected from hardware noise.
+ *
+ * ```js
+ * import { customRandom, random } from './nanoid'
+ * const nanoid = customRandom("abcdef", 5, random)
+ * ```
+ *
+ * @param bytes Size of the array.
+ * @returns An array of random bytes.
+ */
+export function random(bytes: number): Uint8Array

package/dist/types/compiled/nanoid/index.js

@@ -0,0 +1 @@
+(()=>{var e={113:e=>{"use strict";e.exports=require("crypto")},495:(e,r,t)=>{let l=t(113);let{urlAlphabet:a}=t(240);const n=128;let _,u;let fillPool=e=>{if(!_||_.length<e){_=Buffer.allocUnsafe(e*n);l.randomFillSync(_);u=0}else if(u+e>_.length){l.randomFillSync(_);u=0}u+=e};let random=e=>{fillPool(e-=0);return _.subarray(u-e,u)};let customRandom=(e,r,t)=>{let l=(2<<31-Math.clz32(e.length-1|1))-1;let a=Math.ceil(1.6*l*r/e.length);return(n=r)=>{let _="";while(true){let r=t(a);let u=a;while(u--){_+=e[r[u]&l]||"";if(_.length===n)return _}}}};let customAlphabet=(e,r=21)=>customRandom(e,r,random);let nanoid=(e=21)=>{fillPool(e-=0);let r="";for(let t=u-e;t<u;t++){r+=a[_[t]&63]}return r};e.exports={nanoid:nanoid,customAlphabet:customAlphabet,customRandom:customRandom,urlAlphabet:a,random:random}},240:e=>{let r="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";e.exports={urlAlphabet:r}}};var r={};function __nccwpck_require__(t){var l=r[t];if(l!==undefined){return l.exports}var a=r[t]={exports:{}};var n=true;try{e[t](a,a.exports,__nccwpck_require__);n=false}finally{if(n)delete r[t]}return a.exports}if(typeof __nccwpck_require__!=="undefined")__nccwpck_require__.ab=__dirname+"/";var t=__nccwpck_require__(495);module.exports=t})();

package/dist/types/compiled/nanoid/license

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright 2017 Andrey Sitnik <andrey@sitnik.ru>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/types/compiled/nanoid/package.json

@@ -0,0 +1 @@
+{"name":"nanoid","author":"Andrey Sitnik <andrey@sitnik.ru>","version":"3.3.4","license":"MIT","types":"./index.d.ts"}

package/dist/types/compiled/ora/cli-spinners/index.d.ts

@@ -0,0 +1,125 @@
+declare namespace cliSpinners {
+	type SpinnerName =
+		| 'dots'
+		| 'dots2'
+		| 'dots3'
+		| 'dots4'
+		| 'dots5'
+		| 'dots6'
+		| 'dots7'
+		| 'dots8'
+		| 'dots9'
+		| 'dots10'
+		| 'dots11'
+		| 'dots12'
+		| 'dots8Bit'
+		| 'line'
+		| 'line2'
+		| 'pipe'
+		| 'simpleDots'
+		| 'simpleDotsScrolling'
+		| 'star'
+		| 'star2'
+		| 'flip'
+		| 'hamburger'
+		| 'growVertical'
+		| 'growHorizontal'
+		| 'balloon'
+		| 'balloon2'
+		| 'noise'
+		| 'bounce'
+		| 'boxBounce'
+		| 'boxBounce2'
+		| 'triangle'
+		| 'arc'
+		| 'circle'
+		| 'squareCorners'
+		| 'circleQuarters'
+		| 'circleHalves'
+		| 'squish'
+		| 'toggle'
+		| 'toggle2'
+		| 'toggle3'
+		| 'toggle4'
+		| 'toggle5'
+		| 'toggle6'
+		| 'toggle7'
+		| 'toggle8'
+		| 'toggle9'
+		| 'toggle10'
+		| 'toggle11'
+		| 'toggle12'
+		| 'toggle13'
+		| 'arrow'
+		| 'arrow2'
+		| 'arrow3'
+		| 'bouncingBar'
+		| 'bouncingBall'
+		| 'smiley'
+		| 'monkey'
+		| 'hearts'
+		| 'clock'
+		| 'earth'
+		| 'material'
+		| 'moon'
+		| 'runner'
+		| 'pong'
+		| 'shark'
+		| 'dqpb'
+		| 'weather'
+		| 'christmas'
+		| 'grenade'
+		| 'point'
+		| 'layer'
+		| 'betaWave'
+		| 'fingerDance'
+		| 'fistBump'
+		| 'soccerHeader'
+		| 'mindblown'
+		| 'speaker'
+		| 'orangePulse'
+		| 'bluePulse'
+		| 'orangeBluePulse'
+		| 'timeTravel'
+		| 'aesthetic';
+
+	interface Spinner {
+		/**
+		Recommended interval.
+		*/
+		readonly interval: number;
+
+		/**
+		A list of frames to show for the spinner.
+		*/
+		readonly frames: string[];
+	}
+}
+
+/**
+70+ spinners for use in the terminal.
+
+@example
+```
+import cliSpinners = require('../cli-spinners');
+
+console.log(cliSpinners.dots);
+// {
+//   interval: 80,
+//   frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
+// }
+```
+*/
+declare const cliSpinners: {
+	readonly [spinnerName in cliSpinners.SpinnerName]: cliSpinners.Spinner;
+} & {
+	/**
+	Returns a random spinner each time it's called.
+	*/
+	readonly random: cliSpinners.Spinner;
+
+	// TODO: Remove this for the next major release
+	default: typeof cliSpinners;
+};
+
+export = cliSpinners;

package/dist/types/compiled/ora/index.d.ts

@@ -0,0 +1,277 @@
+import {SpinnerName} from './cli-spinners';
+
+declare namespace ora {
+	interface Spinner {
+		readonly interval?: number;
+		readonly frames: string[];
+	}
+
+	type Color =
+		| 'black'
+		| 'red'
+		| 'green'
+		| 'yellow'
+		| 'blue'
+		| 'magenta'
+		| 'cyan'
+		| 'white'
+		| 'gray';
+
+	type PrefixTextGenerator = () => string;
+
+	interface Options {
+		/**
+		Text to display after the spinner.
+		*/
+		readonly text?: string;
+
+		/**
+		Text or a function that returns text to display before the spinner. No prefix text will be displayed if set to an empty string.
+		*/
+		readonly prefixText?: string | PrefixTextGenerator;
+
+		/**
+		Name of one of the provided spinners. See [`example.js`](https://github.com/BendingBender/ora/blob/main/example.js) in this repo if you want to test out different spinners. On Windows, it will always use the line spinner as the Windows command-line doesn't have proper Unicode support.
+
+		@default 'dots'
+
+		Or an object like:
+
+		@example
+		```
+		{
+			interval: 80, // Optional
+			frames: ['-', '+', '-']
+		}
+		```
+		*/
+		readonly spinner?: SpinnerName | Spinner;
+
+		/**
+		Color of the spinner.
+
+		@default 'cyan'
+		*/
+		readonly color?: Color;
+
+		/**
+		Set to `false` to stop Ora from hiding the cursor.
+
+		@default true
+		*/
+		readonly hideCursor?: boolean;
+
+		/**
+		Indent the spinner with the given number of spaces.
+
+		@default 0
+		*/
+		readonly indent?: number;
+
+		/**
+		Interval between each frame.
+
+		Spinners provide their own recommended interval, so you don't really need to specify this.
+
+		Default: Provided by the spinner or `100`.
+		*/
+		readonly interval?: number;
+
+		/**
+		Stream to write the output.
+
+		You could for example set this to `process.stdout` instead.
+
+		@default process.stderr
+		*/
+		readonly stream?: NodeJS.WritableStream;
+
+		/**
+		Force enable/disable the spinner. If not specified, the spinner will be enabled if the `stream` is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
+
+		Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text.
+		*/
+		readonly isEnabled?: boolean;
+
+		/**
+		Disable the spinner and all log text. All output is suppressed and `isEnabled` will be considered `false`.
+
+		@default false
+		*/
+		readonly isSilent?: boolean;
+
+		/**
+		Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on `Enter` key presses, and prevents buffering of input while the spinner is running.
+
+		This has no effect on Windows as there's no good way to implement discarding stdin properly there.
+
+		@default true
+		*/
+		readonly discardStdin?: boolean;
+	}
+
+	interface PersistOptions {
+		/**
+		Symbol to replace the spinner with.
+
+		@default ' '
+		*/
+		readonly symbol?: string;
+
+		/**
+		Text to be persisted after the symbol.
+
+		Default: Current `text`.
+		*/
+		readonly text?: string;
+
+		/**
+		Text or a function that returns text to be persisted before the symbol. No prefix text will be displayed if set to an empty string.
+
+		Default: Current `prefixText`.
+		*/
+		readonly prefixText?: string | PrefixTextGenerator;
+	}
+
+	interface Ora {
+		/**
+		A boolean of whether the instance is currently spinning.
+		*/
+		readonly isSpinning: boolean;
+
+		/**
+		Change the text after the spinner.
+		*/
+		text: string;
+
+		/**
+		Change the text or function that returns text before the spinner. No prefix text will be displayed if set to an empty string.
+		*/
+		prefixText: string | PrefixTextGenerator;
+
+		/**
+		Change the spinner color.
+		*/
+		color: Color;
+
+		/**
+		Change the spinner.
+		*/
+		spinner: SpinnerName | Spinner;
+
+		/**
+		Change the spinner indent.
+		*/
+		indent: number;
+
+		/**
+		Start the spinner.
+
+		@param text - Set the current text.
+		@returns The spinner instance.
+		*/
+		start(text?: string): Ora;
+
+		/**
+		Stop and clear the spinner.
+
+		@returns The spinner instance.
+		*/
+		stop(): Ora;
+
+		/**
+		Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided.
+
+		@param text - Will persist text if provided.
+		@returns The spinner instance.
+		*/
+		succeed(text?: string): Ora;
+
+		/**
+		Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided.
+
+		@param text - Will persist text if provided.
+		@returns The spinner instance.
+		*/
+		fail(text?: string): Ora;
+
+		/**
+		Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided.
+
+		@param text - Will persist text if provided.
+		@returns The spinner instance.
+		*/
+		warn(text?: string): Ora;
+
+		/**
+		Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided.
+
+		@param text - Will persist text if provided.
+		@returns The spinner instance.
+		*/
+		info(text?: string): Ora;
+
+		/**
+		Stop the spinner and change the symbol or text.
+
+		@returns The spinner instance.
+		*/
+		stopAndPersist(options?: PersistOptions): Ora;
+
+		/**
+		Clear the spinner.
+
+		@returns The spinner instance.
+		*/
+		clear(): Ora;
+
+		/**
+		Manually render a new frame.
+
+		@returns The spinner instance.
+		*/
+		render(): Ora;
+
+		/**
+		Get a new frame.
+
+		@returns The spinner instance text.
+		*/
+		frame(): string;
+	}
+}
+
+declare const ora: {
+	/**
+	Elegant terminal spinner.
+
+	@param options - If a string is provided, it is treated as a shortcut for `options.text`.
+
+	@example
+	```
+	import ora = require('./ora');
+
+	const spinner = ora('Loading unicorns').start();
+
+	setTimeout(() => {
+		spinner.color = 'yellow';
+		spinner.text = 'Loading rainbows';
+	}, 1000);
+	```
+	*/
+	(options?: ora.Options | string): ora.Ora;
+
+	/**
+	Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects.
+
+	@param action - The promise to start the spinner for.
+	@param options - If a string is provided, it is treated as a shortcut for `options.text`.
+	@returns The spinner instance.
+	*/
+	promise(
+		action: PromiseLike<unknown>,
+		options?: ora.Options | string
+	): ora.Ora;
+};
+
+export = ora;