UNPKG

3.09 kBTypeScriptView Raw
1/**
2 * Converts a camelized string into all lower case separated by underscores.
3 *
4 ```javascript
5 decamelize('innerHTML'); // 'inner_html'
6 decamelize('action_name'); // 'action_name'
7 decamelize('css-class-name'); // 'css-class-name'
8 decamelize('my favorite items'); // 'my favorite items'
9 ```
10
11 @method decamelize
12 @param {String} str The string to decamelize.
13 @return {String} the decamelized string.
14 */
15export declare function decamelize(str: string): string;
16/**
17 Replaces underscores, spaces, periods, or camelCase with dashes.
18
19 ```javascript
20 dasherize('innerHTML'); // 'inner-html'
21 dasherize('action_name'); // 'action-name'
22 dasherize('css-class-name'); // 'css-class-name'
23 dasherize('my favorite items'); // 'my-favorite-items'
24 dasherize('nrwl.io'); // 'nrwl-io'
25 ```
26
27 @method dasherize
28 @param {String} str The string to dasherize.
29 @return {String} the dasherized string.
30 */
31export declare function dasherize(str?: string): string;
32/**
33 Returns the lowerCamelCase form of a string.
34
35 ```javascript
36 camelize('innerHTML'); // 'innerHTML'
37 camelize('action_name'); // 'actionName'
38 camelize('css-class-name'); // 'cssClassName'
39 camelize('my favorite items'); // 'myFavoriteItems'
40 camelize('My Favorite Items'); // 'myFavoriteItems'
41 ```
42
43 @method camelize
44 @param {String} str The string to camelize.
45 @return {String} the camelized string.
46 */
47export declare function camelize(str: string): string;
48/**
49 Returns the UpperCamelCase form of a string.
50
51 ```javascript
52 'innerHTML'.classify(); // 'InnerHTML'
53 'action_name'.classify(); // 'ActionName'
54 'css-class-name'.classify(); // 'CssClassName'
55 'my favorite items'.classify(); // 'MyFavoriteItems'
56 ```
57
58 @method classify
59 @param {String} str the string to classify
60 @return {String} the classified string
61 */
62export declare function classify(str: string): string;
63/**
64 More general than decamelize. Returns the lower\_case\_and\_underscored
65 form of a string.
66
67 ```javascript
68 'innerHTML'.underscore(); // 'inner_html'
69 'action_name'.underscore(); // 'action_name'
70 'css-class-name'.underscore(); // 'css_class_name'
71 'my favorite items'.underscore(); // 'my_favorite_items'
72 ```
73
74 @method underscore
75 @param {String} str The string to underscore.
76 @return {String} the underscored string.
77 */
78export declare function underscore(str: string): string;
79/**
80 Returns the Capitalized form of a string
81
82 ```javascript
83 'innerHTML'.capitalize() // 'InnerHTML'
84 'action_name'.capitalize() // 'Action_name'
85 'css-class-name'.capitalize() // 'Css-class-name'
86 'my favorite items'.capitalize() // 'My favorite items'
87 ```
88
89 @method capitalize
90 @param {String} str The string to capitalize.
91 @return {String} The capitalized string.
92 */
93export declare function capitalize(str: string): string;
94export declare function group(name: string, group: string | undefined): string;
95export declare function featurePath(group: boolean | undefined, flat: boolean | undefined, path: string, name: string): string;