1. Top
  2. slack-message-parser
  3. Files
  4. api
  5. index.html
slack-message-parser

JavaScript library for parsing Slack message format (mrkdwn)

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
  53. 53
  54. 54
  55. 55
  56. 56
  57. 57
  58. 58
  59. 59
  60. 60
  61. 61
  62. 62
  63. 63
  64. 64
  65. 65
  66. 66
  67. 67
  68. 68
  69. 69
  70. 70
  71. 71
  72. 72
  73. 73
  74. 74
  75. 75
  76. 76
  77. 77
  78. 78
  79. 79
  80. 80
  81. 81
  82. 82
  83. 83
  84. 84
  85. 85
  86. 86
  87. 87
  88. 88
  89. 89
  90. 90
  91. 91
  92. 92
  93. 93
  94. 94
  95. 95
  96. 96
  97. 97
  98. 98
  99. 99
  100. 100
  101. 101
  102. 102
  103. 103
  104. 104
  105. 105
  106. 106
  107. 107
  108. 108
  109. 109
  110. 110
  111. 111
  112. 112
  113. 113
  114. 114
  115. 115
  116. 116
  117. 117
  118. 118
  119. 119
  120. 120
  121. 121
  122. 122
  123. 123
  124. 124
  125. 125
  126. 126
  127. 127
  128. 128
  129. 129
  130. 130
  131. 131
  132. 132
  133. 133
  134. 134
  135. 135
  136. 136
  137. 137
  138. 138
  139. 139
  140. 140
  141. 141
  142. 142
  143. 143
  144. 144
  145. 145
  146. 146
  147. 147
  148. 148
  149. 149
  150. 150
  151. 151
  152. 152
  153. 153
  154. 154
  155. 155
  156. 156
  157. 157
  158. 158
  159. 159
  160. 160
  161. 161
  162. 162
  163. 163
  164. 164
  165. 165
  166. 166
  167. 167
  168. 168
  169. 169
  170. 170
  171. 171
  172. 172
  173. 173
  174. 174
  175. 175
  176. 176
  177. 177
  178. 178
  179. 179
  180. 180
  181. 181
  182. 182
  183. 183
  184. 184
  185. 185
  186. 186
  187. 187
  188. 188
  189. 189
  190. 190
  191. 191
  192. 192
  193. 193
  194. 194
  195. 195
  196. 196
  197. 197
  198. 198
  199. 199
  200. 200
  201. 201
  202. 202
  203. 203
  204. 204
  205. 205
  206. 206
  207. 207
  208. 208
  209. 209
  210. 210
  211. 211
  212. 212
  213. 213
  214. 214
  215. 215
  216. 216
  217. 217
  218. 218
  219. 219
  220. 220
  221. 221
  222. 222
  223. 223
  224. 224
  225. 225
  226. 226
  227. 227
  228. 228
  229. 229
  230. 230
  231. 231
  232. 232
  233. 233
  234. 234
  235. 235
  236. 236
  237. 237
  238. 238
  239. 239
  240. 240
  241. 241
  242. 242
  243. 243
  244. 244
  245. 245
  246. 246
  247. 247
  248. 248
  249. 249
  250. 250
  251. 251
  252. 252
  253. 253
  254. 254
  255. 255
  256. 256
  257. 257
  258. 258
  259. 259
  260. 260
  261. 261
  262. 262
  263. 263
  264. 264
  265. 265
  266. 266
  267. 267
  268. 268
  269. 269
  270. 270
  271. 271
  272. 272
  273. 273
  274. 274
  275. 275
  276. 276
  277. 277
  278. 278
  279. 279
  280. 280
  281. 281
  282. 282
  283. 283
  284. 284
  285. 285
  286. 286
  287. 287
  288. 288
  289. 289
  290. 290
  291. 291
  292. 292
  293. 293
  294. 294
  295. 295
  296. 296
  297. 297
  298. 298
  299. 299
  300. 300
  301. 301
  302. 302
  303. 303
  304. 304
  305. 305
  306. 306
  307. 307
  308. 308
  309. 309
  310. 310
  311. 311 

    <!DOCTYPE html>
    <html lang="en-US">
      <head>
        <meta charset="utf-8" />
        <meta http-equiv="Content-Security-Policy" content="default-src 'self';frame-src https://codesandbox.io;style-src https://pocka.github.io/slack-message-parser/styles.css https://rsms.me/inter/ https://cdn.jsdelivr.net/npm/hack-font@3.3.0/;font-src https://rsms.me/inter/ https://cdn.jsdelivr.net/npm/hack-font@3.3.0/" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <link href="https://rsms.me/inter/inter.css" rel="stylesheet" /><link href="https://cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack-subset.css" rel="stylesheet" />
<title>API | slack-message-parser</title>
        <link rel="stylesheet" href="/slack-message-parser/styles.css" />
      </head>
      <!--
        This site is generated using nano-jsx SSR, lightning-css, remark/rehype, Prism, and Deno.
        Source code at https://github.com/pocka/slack-message-parser/tree/master/docs/site/
      -->
      <body>
        <div class="layout__logo-wrapper  layout__header"><a class="layout__logo" href="/slack-message-parser/">slack<br />message<br />parser</a></div><nav class="layout__nav  layout__header"><ul class="nav__list"><li><a class="nav__link" href="/slack-message-parser/">Intro</a></li><li><a class="nav__link" href="/slack-message-parser/installation/">Install</a></li><li><a class="nav__link" href="/slack-message-parser/api/">API</a></li><li><a class="nav__link" href="/slack-message-parser/examples/">Examples</a></li><li><a class="nav__link" href="https://github.com/pocka/slack-message-parser">GitHub</a></li></ul></nav><div class="layout__header-fill  layout__header"></div><aside class="layout__toc"><div class="toc__root"><nav class="toc"><ol class="toc-level toc-level-1"><li class="toc-item toc-item-h1"><a class="toc-link toc-link-h1" href="#api">API</a><ol class="toc-level toc-level-2"><li class="toc-item toc-item-h2"><a class="toc-link toc-link-h2" href="#function-parsemessage">function parse(message)</a><ol class="toc-level toc-level-3"><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#arguments">Arguments</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#returns">Returns</a></li></ol></li><li class="toc-item toc-item-h2"><a class="toc-link toc-link-h2" href="#interface-node">interface Node</a><ol class="toc-level toc-level-3"><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#root-node">Root node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#text-node">Text node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#channellink-node">ChannelLink node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#userlink-node">UserLink node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#url-node">URL node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#command-node">Command node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#emoji-node">Emoji node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#pretext-node">PreText node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#code-node">Code node</a></li><li class="toc-item toc-item-h3"><a class="toc-link toc-link-h3" href="#italicboldstrikequote-node">Italic/Bold/Strike/Quote node</a></li></ol></li></ol></li></ol></nav></div></aside><main class="layout__main"><div class="markdown__root"><h1 id="api">API</h1>
<h2 id="function-parsemessage"><code>function parse(message)</code></h2>
<p>Parses Slack message and returns a tree (<a href="#interface-node"><code>Node</code></a>).</p>
<h3 id="arguments">Arguments</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>String</td>
<td>a Slack message to parse</td>
</tr>
</tbody>
</table>
<h3 id="returns">Returns</h3>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Root</td>
<td>A root node of the parsed message tree</td>
</tr>
</tbody>
</table>
<h2 id="interface-node"><code>interface Node</code></h2>
<p>Represents each parts of the message, its type and properties.</p>
<p>Every node at least have one property, <code>type</code>.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>Number(NodeType)</td>
<td>Type of the node</td>
</tr>
<tr>
<td>source</td>
<td>String</td>
<td>Raw string of the node</td>
</tr>
</tbody>
</table>
<p>You can test the type with <code>NodeType</code> object (which is actually TypeScript enum).</p>
<pre class="language-js"><code class="language-js"><span class="token keyword module">import</span> <span class="token imports"><span class="token punctuation">{</span> <span class="token maybe-class-name">NodeType</span> <span class="token punctuation">}</span></span> <span class="token keyword module">from</span> <span class="token string">"slack-message-parser"</span><span class="token punctuation">;</span>

<span class="token keyword control-flow">switch</span> <span class="token punctuation">(</span>node<span class="token punctuation">.</span><span class="token property-access">type</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
  <span class="token keyword">case</span> <span class="token maybe-class-name">NodeType</span><span class="token punctuation">.</span><span class="token property-access"><span class="token maybe-class-name">Text</span></span><span class="token operator">:</span>
  <span class="token comment">// ...</span>
  <span class="token keyword">case</span> <span class="token maybe-class-name">NodeType</span><span class="token punctuation">.</span><span class="token property-access"><span class="token maybe-class-name">ChannelLink</span></span><span class="token operator">:</span>
    <span class="token comment">// ...</span>
<span class="token punctuation">}</span>
</code></pre>
<p>The names of Node and NodeType are one-to-one equivalent (e.g. <code>Text</code> node have <code>type</code> property that the value is <code>NodeType.Text</code>).</p>
<h3 id="root-node"><code>Root</code> node</h3>
<p>A node sits on top of the tree. Every parse result have this node as its root node.</p>
<h4 id="properties">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>children</td>
<td>Node[]</td>
<td>Child nodes</td>
</tr>
</tbody>
</table>
<h3 id="text-node"><code>Text</code> node</h3>
<p>Texts.</p>
<h4 id="properties-1">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>Text content</td>
</tr>
</tbody>
</table>
<h3 id="channellink-node"><code>ChannelLink</code> node</h3>
<p>Link to a channel.</p>
<h4 id="properties-2">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>channelID</td>
<td>String</td>
<td>An ID of the channel</td>
</tr>
<tr>
<td>label</td>
<td>Node[] | undefined</td>
<td>Display texts for the link</td>
</tr>
</tbody>
</table>
<h3 id="userlink-node"><code>UserLink</code> node</h3>
<p>Link to a user.</p>
<h4 id="properties-3">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>userId</td>
<td>String</td>
<td>An ID of the user</td>
</tr>
<tr>
<td>label</td>
<td>Node[] | undefined</td>
<td>Display texts for the user</td>
</tr>
</tbody>
</table>
<h3 id="url-node"><code>URL</code> node</h3>
<p>Link other than channels and users (e.g. <code>https://foo.bar</code>, <code>mailto:foo@bar</code>).</p>
<h4 id="properties-4">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>url</td>
<td>String</td>
<td>A link url</td>
</tr>
<tr>
<td>label</td>
<td>Node[] | undefined</td>
<td>Display texts for the link</td>
</tr>
</tbody>
</table>
<h3 id="command-node"><code>Command</code> node</h3>
<p>Special commands like <code>&#x3C;!date></code>, <code>&#x3C;!everyone></code>, <code>&#x3C;!subteam^id|@handle></code>, and more.
For more details, please refer <a href="https://api.slack.com/docs/message-formatting">Formatting messages | Slack</a>.</p>
<h4 id="properties-5">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>String</td>
<td>A name of the command</td>
</tr>
<tr>
<td>arguments</td>
<td>String[]</td>
<td>Command arguments(prefixed by <code>^</code>, <code>ID</code> is an argument of <code>&#x3C;!subteam^ID></code>)</td>
</tr>
<tr>
<td>label</td>
<td>Node[] | undefined</td>
<td>Display texts for the link</td>
</tr>
</tbody>
</table>
<h3 id="emoji-node"><code>Emoji</code> node</h3>
<p>Emojis!</p>
<h4 id="properties-6">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>String</td>
<td>A name of the emoji (the text between both <code>:</code>s)</td>
</tr>
<tr>
<td>variation</td>
<td>String | undefined</td>
<td>Emoji variation, currently <code>skin-tone-</code> only</td>
</tr>
</tbody>
</table>
<h3 id="pretext-node"><code>PreText</code> node</h3>
<p>Code block. Multi-line codes.</p>
<h4 id="properties-7">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>Text content</td>
</tr>
</tbody>
</table>
<h3 id="code-node"><code>Code</code> node</h3>
<p>Inline code.</p>
<h4 id="properties-8">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>String</td>
<td>Text content</td>
</tr>
</tbody>
</table>
<h3 id="italicboldstrikequote-node"><code>Italic</code>/<code>Bold</code>/<code>Strike</code>/<code>Quote</code> node</h3>
<p>Represents text decorations. Each nodes just have decoration information, so it acts as container (does not hold texts directly).</p>
<h4 id="properties-9">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>children</td>
<td>Node[]</td>
<td>Child nodes</td>
</tr>
</tbody>
</table></div></main>
        
      </body>
    </html>