minor adjustment to readme
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / figures / index.d.ts
1 declare const figureSet: {
2         readonly tick: string;
3         readonly cross: string;
4         readonly star: string;
5         readonly square: string;
6         readonly squareSmall: string;
7         readonly squareSmallFilled: string;
8         readonly play: string;
9         readonly circle: string;
10         readonly circleFilled: string;
11         readonly circleDotted: string;
12         readonly circleDouble: string;
13         readonly circleCircle: string;
14         readonly circleCross: string;
15         readonly circlePipe: string;
16         readonly circleQuestionMark: string;
17         readonly bullet: string;
18         readonly dot: string;
19         readonly line: string;
20         readonly ellipsis: string;
21         readonly pointer: string;
22         readonly pointerSmall: string;
23         readonly info: string;
24         readonly warning: string;
25         readonly hamburger: string;
26         readonly smiley: string;
27         readonly mustache: string;
28         readonly heart: string;
29         readonly nodejs: string;
30         readonly arrowUp: string;
31         readonly arrowDown: string;
32         readonly arrowLeft: string;
33         readonly arrowRight: string;
34         readonly radioOn: string;
35         readonly radioOff: string;
36         readonly checkboxOn: string;
37         readonly checkboxOff: string;
38         readonly checkboxCircleOn: string;
39         readonly checkboxCircleOff: string;
40         readonly questionMarkPrefix: string;
41         readonly oneHalf: string;
42         readonly oneThird: string;
43         readonly oneQuarter: string;
44         readonly oneFifth: string;
45         readonly oneSixth: string;
46         readonly oneSeventh: string;
47         readonly oneEighth: string;
48         readonly oneNinth: string;
49         readonly oneTenth: string;
50         readonly twoThirds: string;
51         readonly twoFifths: string;
52         readonly threeQuarters: string;
53         readonly threeFifths: string;
54         readonly threeEighths: string;
55         readonly fourFifths: string;
56         readonly fiveSixths: string;
57         readonly fiveEighths: string;
58         readonly sevenEighth: string;
59 }
60
61 type FigureSet = typeof figureSet
62
63 declare const figures: {
64         /**
65         Replace Unicode symbols depending on the OS.
66
67         @param string - String where the Unicode symbols will be replaced with fallback symbols depending on the OS.
68         @returns The input with replaced fallback Unicode symbols on Windows.
69
70         @example
71         ```
72         import figures = require('figures');
73
74         console.log(figures('✔︎ check'));
75         // On non-Windows OSes:  ✔︎ check
76         // On Windows:           √ check
77
78         console.log(figures.tick);
79         // On non-Windows OSes:  ✔︎
80         // On Windows:           √
81         ```
82         */
83         (string: string): string;
84
85         /**
86         Symbols to use when not running on Windows.
87         */
88         readonly main: FigureSet;
89
90         /**
91         Symbols to use when running on Windows.
92         */
93         readonly windows: FigureSet;
94 } & FigureSet;
95
96 export = figures;