Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add API docs for commands API #217

Merged
merged 1 commit into from
Aug 21, 2020
Merged

Add API docs for commands API #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions _api/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ The Command API lets you add new commands.

## Methods

### `#add(command: Object)`
### `#add(commandText: string, command: Object)`

Adds a new command.
Registers a new command for users on the lounge.

`commandText` is what the users will type after `/`, and command is the command object.

Attributes of command:

Expand Down