优化

‘liusuyi’

2023-10-21 ae92b6823499cfab77201b4033922fa373fb37a3

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
 * Wrap words to a specified length.
 */
export = wrap;
 
declare function wrap(str: string, options?: wrap.IOptions): string;
 
declare namespace wrap {
    export interface IOptions {
 
        /**
         * The width of the text before wrapping to a new line.
         * @default ´50´
         */
        width?: number;
 
        /**
         * The string to use at the beginning of each line.
         * @default ´  ´ (two spaces)
         */
        indent?: string;
 
        /**
         * The string to use at the end of each line.
         * @default ´\n´
         */
        newline?: string;
 
        /**
         * An escape function to run on each line after splitting them.
         * @default (str: string) => string;
         */
        escape?: (str: string) => string;
 
        /**
         * Trim trailing whitespace from the returned string.
         * This option is included since .trim() would also strip
         * the leading indentation from the first line.
         * @default true
         */
        trim?: boolean;
 
        /**
         * Break a word between any two letters when the word is longer
         * than the specified width.
         * @default false
         */
        cut?: boolean;
    }
}