diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a1476e..15d4148 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Change Log +## v0.1.4 – 2020-06-14 + +* Fix minor typo in class name that was creating issue with doc generation. +* Add JSDoc comments with links to Slack API for a few classes. + ## v0.1.3 - 2020-06-13 * Add project logo (kudos to Alexey Chernyshov). diff --git a/package.json b/package.json index 4dfbf5b..a3eea43 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "slack-block-builder", - "version": "0.1.3", + "version": "0.1.4", "description": "Lightweight, zero-dependency library for creating Slack messages and modals, with a builder interface inspired by SwiftUI.", "author": { "name": "Ray East", diff --git a/src/blocks/divider.js b/src/blocks/divider.js index 76c3c45..543a00a 100644 --- a/src/blocks/divider.js +++ b/src/blocks/divider.js @@ -31,6 +31,10 @@ class Divider extends Block { } } +/** + * {@link https://api.slack.com/reference/block-kit/blocks#divider|View in Slack API Documentation} + */ + module.exports = { Divider, DividerDto, diff --git a/src/elements/base/multiselect-element.js b/src/elements/base/multiselect-element.js index 2dff906..c832698 100644 --- a/src/elements/base/multiselect-element.js +++ b/src/elements/base/multiselect-element.js @@ -1,7 +1,7 @@ const SelectElement = require('./select-element'); const { props } = require('../../utility/constants'); -class MutliSelectElement extends SelectElement { +class MultiSelectElement extends SelectElement { /** * Sets a limit to how many items the user can select in any one MultiSelect @@ -17,4 +17,4 @@ class MutliSelectElement extends SelectElement { } } -module.exports = MutliSelectElement; +module.exports = MultiSelectElement; diff --git a/src/elements/overflow-menu.js b/src/elements/overflow-menu.js index 123c7cf..1718512 100644 --- a/src/elements/overflow-menu.js +++ b/src/elements/overflow-menu.js @@ -43,3 +43,7 @@ module.exports = { OverflowMenu, OverflowMenuDto, }; + +/** + * {@link https://api.slack.com/reference/block-kit/block-elements#overflow|View in Slack API Documentation} + */ diff --git a/src/surfaces/home-tab.js b/src/surfaces/home-tab.js index a5ff7eb..f65ebe9 100644 --- a/src/surfaces/home-tab.js +++ b/src/surfaces/home-tab.js @@ -45,3 +45,7 @@ module.exports = { HomeTab, HomeTabDto, }; + +/** + * {@link https://api.slack.com/reference/surfaces/views|View in Slack API Documentation} + */