@enonic-types/lib-common 0.1.1 → 7.11.0-B1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/common.d.ts +24 -24
- package/package.json +32 -32
package/common.d.ts
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
|
-
declare global {
|
|
2
|
-
interface XpLibraries {
|
|
3
|
-
'/lib/xp/common': typeof import('./common');
|
|
4
|
-
}
|
|
5
|
-
}
|
|
6
|
-
/**
|
|
7
|
-
* Transform a text string so that it can be safely used in cases where the range of accepted characters is restricted.
|
|
8
|
-
*
|
|
9
|
-
* Some usage examples are: as an XP content or node name, as a principal name, in a URL or in a filesystem path.
|
|
10
|
-
*
|
|
11
|
-
* The following changes will be applied to the input text:
|
|
12
|
-
* - convert characters to lowercase (according to the rules of the default locale)
|
|
13
|
-
* - replace punctuation symbols and blank spaces with the hyphen character ('-')
|
|
14
|
-
* - remove some unsafe and invisible Unicode characters
|
|
15
|
-
* - strip duplicated hyphen characters
|
|
16
|
-
* - remove diacritic characters
|
|
17
|
-
* - map letters to the English alphabet (ASCII encoding)
|
|
18
|
-
*
|
|
19
|
-
* @example-ref examples/common/sanitize.js
|
|
20
|
-
*
|
|
21
|
-
* @param {string} text Text string to sanitize.
|
|
22
|
-
* @returns {string} Sanitized text.
|
|
23
|
-
*/
|
|
24
|
-
export declare function sanitize(text: string): string;
|
|
1
|
+
declare global {
|
|
2
|
+
interface XpLibraries {
|
|
3
|
+
'/lib/xp/common': typeof import('./common');
|
|
4
|
+
}
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Transform a text string so that it can be safely used in cases where the range of accepted characters is restricted.
|
|
8
|
+
*
|
|
9
|
+
* Some usage examples are: as an XP content or node name, as a principal name, in a URL or in a filesystem path.
|
|
10
|
+
*
|
|
11
|
+
* The following changes will be applied to the input text:
|
|
12
|
+
* - convert characters to lowercase (according to the rules of the default locale)
|
|
13
|
+
* - replace punctuation symbols and blank spaces with the hyphen character ('-')
|
|
14
|
+
* - remove some unsafe and invisible Unicode characters
|
|
15
|
+
* - strip duplicated hyphen characters
|
|
16
|
+
* - remove diacritic characters
|
|
17
|
+
* - map letters to the English alphabet (ASCII encoding)
|
|
18
|
+
*
|
|
19
|
+
* @example-ref examples/common/sanitize.js
|
|
20
|
+
*
|
|
21
|
+
* @param {string} text Text string to sanitize.
|
|
22
|
+
* @returns {string} Sanitized text.
|
|
23
|
+
*/
|
|
24
|
+
export declare function sanitize(text: string): string;
|
package/package.json
CHANGED
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@enonic-types/lib-common",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "Type definitions for lib-common.",
|
|
5
|
-
"types": "common.d.ts",
|
|
6
|
-
"files": [
|
|
7
|
-
"common.d.ts"
|
|
8
|
-
],
|
|
9
|
-
"repository": {
|
|
10
|
-
"type": "git",
|
|
11
|
-
"url": "git+https://github.com/enonic/xp.git#master"
|
|
12
|
-
},
|
|
13
|
-
"keywords": [
|
|
14
|
-
"enonic",
|
|
15
|
-
"enonic-xp",
|
|
16
|
-
"lib-common",
|
|
17
|
-
"common",
|
|
18
|
-
"types",
|
|
19
|
-
"typescript"
|
|
20
|
-
],
|
|
21
|
-
"contributors": [
|
|
22
|
-
"Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
|
|
23
|
-
],
|
|
24
|
-
"license": "Apache-2.0",
|
|
25
|
-
"bugs": {
|
|
26
|
-
"url": "https://github.com/enonic/xp/issues"
|
|
27
|
-
},
|
|
28
|
-
"homepage": "https://github.com/enonic/xp/tree/master#readme",
|
|
29
|
-
"publishConfig": {
|
|
30
|
-
"access": "public"
|
|
31
|
-
}
|
|
32
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@enonic-types/lib-common",
|
|
3
|
+
"version": "7.11.0-B1",
|
|
4
|
+
"description": "Type definitions for lib-common.",
|
|
5
|
+
"types": "common.d.ts",
|
|
6
|
+
"files": [
|
|
7
|
+
"common.d.ts"
|
|
8
|
+
],
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/enonic/xp.git#master"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"enonic",
|
|
15
|
+
"enonic-xp",
|
|
16
|
+
"lib-common",
|
|
17
|
+
"common",
|
|
18
|
+
"types",
|
|
19
|
+
"typescript"
|
|
20
|
+
],
|
|
21
|
+
"contributors": [
|
|
22
|
+
"Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
|
|
23
|
+
],
|
|
24
|
+
"license": "Apache-2.0",
|
|
25
|
+
"bugs": {
|
|
26
|
+
"url": "https://github.com/enonic/xp/issues"
|
|
27
|
+
},
|
|
28
|
+
"homepage": "https://github.com/enonic/xp/tree/master#readme",
|
|
29
|
+
"publishConfig": {
|
|
30
|
+
"access": "public"
|
|
31
|
+
}
|
|
32
|
+
}
|