UNPKG

lib-songbeamer

Version:

transforming SongBeamer Song-Files and Ablaufplan-Files

github.com/webdad/lib-songbeamer

webdad/lib-songbeamer

107 lines • 7.43 kB
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
��<a name="module_ablaud"></a> ## ablaud Gets Json from and json to Ablaufplan-files **Version**: 1.0 **Author**: Dominik Sigmund * [ablaud](#module_ablaud) * _static_ * [.toFile(json, callback)](#module_ablaud.toFile) ��� * _inner_ * [~regex](#module_ablaud..regex) ��� * [~clean(text)](#module_ablaud..clean) ��� <code>String</code> * [~color2Hex(color)](#module_ablaud..color2Hex) ��� <code>string</code> * [~hex2Color(hex)](#module_ablaud..hex2Color) ��� <code>string</code> * [~getType(caption, filename)](#module_ablaud..getType) ��� <code>string</code> * [~colourNameToHex(colour)](#module_ablaud..colourNameToHex) ��� <code>string</code> <a name="module_ablaud.toFile"></a> ### ablaud.toFile(json, callback) ��� Write Json to a File String **Kind**: static method of [<code>ablaud</code>](#module_ablaud) **Returns**: Nothing | Param | Type | Description | | --- | --- | --- | | json | <code>object</code> | String as delivered by fs.readFile | | callback | [<code>stringCallback</code>](#ablauf..stringCallback) | A Callback with an error or the String as delivered to fs.writeFile | <a name="module_ablaud..regex"></a> ### ablaud~regex ��� Get Json from a string **Kind**: inner constant of [<code>ablaud</code>](#module_ablaud) **Returns**: Nothing | Param | Type | Description | | --- | --- | --- | | data | <code>string</code> | String as delivered by fs.readFile | | callback | [<code>jsonCallback</code>](#ablauf..jsonCallback) | A Callback with an error or the Json | <a name="module_ablaud..clean"></a> ### ablaud~clean(text) ��� <code>String</code> Removes Strange Symbols from the Text for a better json **Kind**: inner method of [<code>ablaud</code>](#module_ablaud) **Returns**: <code>String</code> - - A cleaner bit of Text | Param | Type | Description | | --- | --- | --- | | text | <code>string</code> | A Bite of Text | <a name="module_ablaud..color2Hex"></a> ### ablaud~color2Hex(color) ��� <code>string</code> Takes Color Information and returns a css-hex-representation **Kind**: inner method of [<code>ablaud</code>](#module_ablaud) **Returns**: <code>string</code> - - A clean hex-rep | Param | Type | Description | | --- | --- | --- | | color | <code>string</code> | Some weird color (string, windows decimal, ...) | <a name="module_ablaud..hex2Color"></a> ### ablaud~hex2Color(hex) ��� <code>string</code> Takes a Hex-Color and makes a windows-decimal-color out of it. **Kind**: inner method of [<code>ablaud</code>](#module_ablaud) **Returns**: <code>string</code> - - Windows Decimal Color | Param | Type | Description | | --- | --- | --- | | hex | <code>string</code> | A Hex Color | <a name="module_ablaud..getType"></a> ### ablaud~getType(caption, filename) ��� <code>string</code> Guesses the Type of the Item **Kind**: inner method of [<code>ablaud</code>](#module_ablaud) **Returns**: <code>string</code> - - Type, may be: song, video, powerpoint, sermon, unknown | Param | Type | Description | | --- | --- | --- | | caption | <code>string</code> | The Caption of the item | | filename | <code>string</code> | The Filename of the item | <a name="module_ablaud..colourNameToHex"></a> ### ablaud~colourNameToHex(colour) ��� <code>string</code> Takes a cssColor-Name and returns the hex-value or an empty string **Kind**: inner method of [<code>ablaud</code>](#module_ablaud) **Returns**: <code>string</code> - - A Hex-Color or an empty String | Param | Type | Description | | --- | --- | --- | | colour | <code>string</code> | A ColourName |