-
Notifications
You must be signed in to change notification settings - Fork 0
/
IJtConfig.ts
58 lines (53 loc) · 1.98 KB
/
IJtConfig.ts
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
51
52
53
54
55
56
57
58
/*
* The MIT License (MIT)
*
* Copyright (c) 2019 Denis Kuzmin < entry.reg@gmail.com > GitHub/3F
*
* 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.
*/
export interface IJtConfig
{
/**
* Opening tag. E.g.: '{{' + name.
*/
op: string | undefined;
/**
* Ending tag. E.g.: name + '}}'.
*/
ed: string | undefined;
/**
* Sets `op` + `ed` tags via pair logic.
* - '%': '%' + name + '%'
* - '{}': '{' + name + '}'
* - '{{}}': '{{' + name + '}}'
* - '{{}': '{{' + name + '}'
*/
pair(value: string): void;
/**
* Formats input word as user tag.
* @param word Input word.
*/
tag(word: string): string;
/**
* Tries to make new configuration.
* @param config {IJtConfig | string | undefined} Either string to constructor or available config instance.
* @returns {JtConfig} Returns new instance or this if it's failed.
*/
try(config?: IJtConfig | string): IJtConfig;
}