-
Notifications
You must be signed in to change notification settings - Fork 26
/
Copy pathProperCase.html
251 lines (226 loc) · 9.21 KB
/
ProperCase.html
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.22.1">
<meta name="project" content="proper_case v1.3.1">
<title>ProperCase — proper_case v1.3.1</title>
<link rel="stylesheet" href="dist/elixir-e589b8fad3dab6230c65.css" />
<script src="dist/sidebar_items-91207318ba.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-5c0c23dfec2d63ae33a2.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode') === 'true') document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button">
<span class="icon-cross" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" id="search-list" class="search-input" placeholder="Search..." aria-label="Search" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="api-reference.html" class="sidebar-projectName">
proper_case </a>
<h2 class="sidebar-projectVersion">
v1.3.1
</h2>
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="app-vsn">proper_case v1.3.1</small>
ProperCase </h1>
<section id="moduledoc">
<p>An Elixir library that converts keys in maps between <code class="inline">snake_case</code> and <code class="inline">camel_case</code></p> </section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#camel_case/1">camel_case(key)</a>
</div>
<div class="summary-synopsis"><p>Converts an atom to a <code class="inline">camelCase</code> string</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#camel_case/2">camel_case(key, mode)</a>
</div>
<div class="summary-synopsis"><p>Converts a string to <code class="inline">camelCase</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#snake_case/1">snake_case(val)</a>
</div>
<div class="summary-synopsis"><p>Converts a string to <code class="inline">snake_case</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#to_camel_case/1">to_camel_case(any)</a>
</div>
<div class="summary-synopsis"><p>Converts all the keys in a map to <code class="inline">camelCase</code> if mode is :lower or <code class="inline">CamleCase</code> if mode is :upper.
If the map is a struct with no <a href="https://hexdocs.pm/elixir/Enumerable.html"><code class="inline">Enumerable</code></a> implementation,
the struct is considered to be a single value.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#to_camel_case/2">to_camel_case(map, mode)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#to_snake_case/1">to_snake_case(map)</a>
</div>
<div class="summary-synopsis"><p>Converts all the keys in a map to <code class="inline">snake_case</code>.
If the map is a struct with no <a href="https://hexdocs.pm/elixir/Enumerable.html"><code class="inline">Enumerable</code></a> implementation,
the struct is considered to be a single value.</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions </h1>
<div class="functions-list">
<section class="detail" id="camel_case/1">
<div class="detail-header">
<a href="#camel_case/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">camel_case(key)</h1>
</div>
<section class="docstring">
<p>Converts an atom to a <code class="inline">camelCase</code> string</p> </section>
</section>
<section class="detail" id="camel_case/2">
<div class="detail-header">
<a href="#camel_case/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">camel_case(key, mode)</h1>
</div>
<section class="docstring">
<p>Converts a string to <code class="inline">camelCase</code></p> </section>
</section>
<section class="detail" id="snake_case/1">
<div class="detail-header">
<a href="#snake_case/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">snake_case(val)</h1>
</div>
<section class="docstring">
<p>Converts a string to <code class="inline">snake_case</code></p> </section>
</section>
<section class="detail" id="to_camel_case/1">
<div class="detail-header">
<a href="#to_camel_case/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">to_camel_case(any)</h1>
</div>
<section class="docstring">
<p>Converts all the keys in a map to <code class="inline">camelCase</code> if mode is :lower or <code class="inline">CamleCase</code> if mode is :upper.
If the map is a struct with no <a href="https://hexdocs.pm/elixir/Enumerable.html"><code class="inline">Enumerable</code></a> implementation,
the struct is considered to be a single value.</p> </section>
</section>
<section class="detail" id="to_camel_case/2">
<div class="detail-header">
<a href="#to_camel_case/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">to_camel_case(map, mode)</h1>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="to_snake_case/1">
<div class="detail-header">
<a href="#to_snake_case/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature">to_snake_case(map)</h1>
</div>
<section class="docstring">
<p>Converts all the keys in a map to <code class="inline">snake_case</code>.
If the map is a struct with no <a href="https://hexdocs.pm/elixir/Enumerable.html"><code class="inline">Enumerable</code></a> implementation,
the struct is considered to be a single value.</p> </section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener">ExDoc</a> (v0.22.1),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
<button class="line footer-button night-mode-toggle">
Toggle night mode
</button>
<button class="line footer-button display-quick-switch">
Go to a HexDocs package
</button>
<button class="line footer-button tooltips-toggle">
<span class="tooltips-option-disable">Disable tooltips</span>
<span class="tooltips-option-enable">Enable tooltips</span>
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>