-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
243 lines (242 loc) · 15.8 KB
/
index.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
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>node-groupme</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<ul class="results-priority" style="display:none">
</ul>
<a href="index.html" class="title">node-groupme</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
</ul>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-3 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
</div>
<div class="col-7 offset-3 col-content">
<h1>Project node-groupme</h1>
<div class="tsd-panel tsd-typography">
<a href="#node-groupme" id="node-groupme" style="color: inherit; text-decoration: none;">
<h1>node-groupme</h1>
</a>
<table>
<thead>
<tr>
<th>✔️ This package is in active development! If you'd like to contribute, <a href="https://github.com/groupme-js/node-groupme/contribute">click here</a> 🙂</th>
</tr>
</thead>
</table>
<a href="#about" id="about" style="color: inherit; text-decoration: none;">
<h3>About</h3>
</a>
<p>Inspired by <a href="https://github.com/discordjs/discord.js">discord.js</a>, <code>node-groupme</code> aims to replace the obsolete <a href="https://www.npmjs.com/package/groupme">groupme</a> package with a modern, object-oriented, intuitive approach to interacting with the GroupMe API.</p>
<br>
<p><a href="https://npmjs.com/node-groupme"><img src="https://img.shields.io/npm/v/node-groupme?style=for-the-badge" alt="npm"></a>
<a href="https://groupme.js.org"><img src="https://img.shields.io/npm/v/node-groupme?color=red&label=Docs%20version&style=for-the-badge" alt="npm"></a>
<a href="https://discord.gg/5yxWtuuEZg"><img src="https://img.shields.io/discord/898587555249946664?color=blue&label=Discord&style=for-the-badge" alt="Discord"></a>
<br><br></p>
<hr>
<p>This community-led effort is made possible by the <a href="https://github.com/2CATteam/GroupMeCommunityDocs">unofficial GroupMe API Community Docs</a>. Please contribute to the development of open-source applications by contributing to the community docs.</p>
<p>Join the <a href="https://discord.gg/5yxWtuuEZg">node-groupme server on Discord</a> to discuss the API or ask any questions.</p>
<hr>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h3>Getting Started</h3>
</a>
<pre><code><span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">i</span><span style="color: #000000"> </span><span style="color: #001080">node</span><span style="color: #000000">-</span><span style="color: #001080">groupme</span>
</code></pre>
<pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">GroupMe</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">'node-groupme'</span><span style="color: #000000">);</span>
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #001080">GroupMe</span><span style="color: #000000">.</span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #A31515">'YOUR_TOKEN_HERE'</span><span style="color: #000000">);</span>
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">login</span><span style="color: #000000">()</span>
<span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">client</span><span style="color: #000000"> </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #001080">groups</span><span style="color: #000000">.</span><span style="color: #795E26">fetch</span><span style="color: #000000">())</span>
<span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">groups</span><span style="color: #000000"> </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #001080">groups</span><span style="color: #000000">.</span><span style="color: #795E26">forEach</span><span style="color: #000000">(</span><span style="color: #001080">group</span><span style="color: #000000"> </span><span style="color: #0000FF">=></span><span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">group</span><span style="color: #000000">.</span><span style="color: #001080">name</span><span style="color: #000000">)))</span>
<span style="color: #000000"> .</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #001080">logout</span><span style="color: #000000">)</span>
<span style="color: #000000"> .</span><span style="color: #795E26">catch</span><span style="color: #000000">(</span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #001080">error</span><span style="color: #000000">);</span>
</code></pre>
<hr>
<a href="#getting-started-contributing" id="getting-started-contributing" style="color: inherit; text-decoration: none;">
<h3>Getting Started (Contributing)</h3>
</a>
<pre><code><span style="color: #001080">git</span><span style="color: #000000"> </span><span style="color: #001080">clone</span><span style="color: #000000"> </span><span style="color: #001080">git</span><span style="color: #000000">@</span><span style="color: #001080">github</span><span style="color: #000000">.</span><span style="color: #001080">com</span><span style="color: #000000">:</span><span style="color: #001080">groupme</span><span style="color: #000000">-</span><span style="color: #001080">js</span><span style="color: #000000">/</span><span style="color: #001080">node</span><span style="color: #000000">-</span><span style="color: #001080">groupme</span><span style="color: #000000">.</span><span style="color: #001080">git</span>
<span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">i</span>
<span style="color: #001080">npm</span><span style="color: #000000"> </span><span style="color: #001080">run</span><span style="color: #000000"> </span><span style="color: #001080">prepare</span>
</code></pre>
<p><code>npm run prepare</code> sets up <a href="https://github.com/typicode/husky">husky</a> pre-commit hooks, which will auto format and run eslint on your staged files locally. </p>
</div>
<!--{"options":"/home/runner/work/node-groupme/node-groupme","tsconfig":"/home/runner/work/node-groupme/node-groupme","packages":[],"entryPoints":["/home/runner/work/node-groupme/node-groupme/src/index.ts"],"exclude":[],"externalPattern":["**/node_modules/**"],"excludeExternals":false,"excludeNotDocumented":false,"excludeInternal":false,"excludePrivate":false,"excludeProtected":false,"disableSources":false,"includes":"","media":"","watch":false,"preserveWatchOutput":false,"emit":false,"out":"/home/runner/work/node-groupme/node-groupme/docs","json":"","pretty":true,"theme":"./node_modules/typedoc-neo-theme/bin/default","highlightTheme":"light-plus","name":"","includeVersion":false,"excludeTags":[],"readme":"","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"sort":["kind","instance-first","alphabetical"],"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":false,"toc":[],"disableOutputCheck":false,"help":false,"version":false,"showConfig":false,"plugin":[],"logger":"console","logLevel":1,"treatWarningsAsErrors":false,"listInvalidSymbolLinks":false}-->
</div>
<div class="col-2 col-menu secondary-menu">
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum root">
<a href="enums/ChannelType.html" class="tsd-kind-icon">Channel<wbr>Type</a>
</li>
<li class=" tsd-kind-enum root">
<a href="enums/FormerMemberState.html" class="tsd-kind-icon">Former<wbr>Member<wbr>State</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Attachment.html" class="tsd-kind-icon">Attachment</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Base.html" class="tsd-kind-icon">Base</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/BaseGroup.html" class="tsd-kind-icon">Base<wbr>Group</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter root">
<a href="classes/BaseManager.html" class="tsd-kind-icon">Base<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Channel.html" class="tsd-kind-icon">Channel</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Chat.html" class="tsd-kind-icon">Chat</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/ChatManager.html" class="tsd-kind-icon">Chat<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/ChatMessage.html" class="tsd-kind-icon">Chat<wbr>Message</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/ChatMessageManager.html" class="tsd-kind-icon">Chat<wbr>Message<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter tsd-is-external root">
<a href="classes/Collection.html" class="tsd-kind-icon">Collection</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/FormerGroup.html" class="tsd-kind-icon">Former<wbr>Group</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/FormerGroupManager.html" class="tsd-kind-icon">Former<wbr>Group<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/FormerMember.html" class="tsd-kind-icon">Former<wbr>Member</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/FormerMemberManager.html" class="tsd-kind-icon">Former<wbr>Member<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Group.html" class="tsd-kind-icon">Group</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/GroupManager.html" class="tsd-kind-icon">Group<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/GroupMessage.html" class="tsd-kind-icon">Group<wbr>Message</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/GroupMessageManager.html" class="tsd-kind-icon">Group<wbr>Message<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Member.html" class="tsd-kind-icon">Member</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/MemberManager.html" class="tsd-kind-icon">Member<wbr>Manager</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter root">
<a href="classes/Message.html" class="tsd-kind-icon">Message</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/MessageLikeManager.html" class="tsd-kind-icon">Message<wbr>Like<wbr>Manager</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter root">
<a href="classes/MessageManager.html" class="tsd-kind-icon">Message<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Poll.html" class="tsd-kind-icon">Poll</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/PollManager.html" class="tsd-kind-icon">Poll<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/PollOption.html" class="tsd-kind-icon">Poll<wbr>Option</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/Relationship.html" class="tsd-kind-icon">Relationship</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/RelationshipManager.html" class="tsd-kind-icon">Relationship<wbr>Manager</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/User.html" class="tsd-kind-icon">User</a>
</li>
<li class=" tsd-kind-class root">
<a href="classes/UserManager.html" class="tsd-kind-icon">User<wbr>Manager</a>
</li>
<li class=" tsd-kind-interface root">
<a href="interfaces/SendableChannelInterface.html" class="tsd-kind-icon">Sendable<wbr>Channel<wbr>Interface</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>