spellar

Spellar module. Responsible for automatically correcting spelling errors

• spellar
• static
  • .description
  • .configuration
  • .name
  • .priority
  • .version
  • .begin(browser, config)
  • .registerListeners(callback)
  • .onMessage(message, post, callback)
• inner
  • ~initialiseDictionary()
  • ~loadAddtitionalDictionaries()
  • ~spellCheckPost(post, callback)

spellar.description

Description of the module

Kind: static property of spellar

spellar.configuration

Configuration properties.

Kind: static property of spellar
Properties

Name	Description
enabled	Whether to use Spellar or not. Defaults to false.
checkOwnPosts	Whether to use check the user's own posts or not. Defaults to false.
baseDictLocation	The directory containing the base dictionary. Defaults to dictionaries.
baseDictLocation	The name of the base dictionary. Defaults to en_US.
baseDictLocation	The directory containing extra dictionaries. Defaults to dictionaries.
baseDictLocation	An array of names of extra dictionaries. Defaults to an empty array.

spellar.name

Name of the module

Kind: static property of spellar

spellar.priority

Priority of the module

Kind: static property of spellar

spellar.version

Module version

Kind: static property of spellar

spellar.begin(browser, config)

Bootstrap the module.

Kind: static method of spellar

Param	Type	Description
browser	object	The Discourse interface object
config	object	The SockBot config object

spellar.registerListeners(callback)

Register the required listeners.

Kind: static method of spellar

Param	Type	Description
callback	function	The callback to use once the action is complete

spellar.onMessage(message, post, callback)

Handle received messages.

Kind: static method of spellar

Param	Type	Description
message	object	An object representing the message that was received
post	object	An object representing the post that the message was about
callback	function	The callback to use once the action is complete

spellar~initialiseDictionary()

Initialise the dictionary.

Kind: inner method of spellar

spellar~loadAddtitionalDictionaries()

Load additional dictionaries, if provided.

Kind: inner method of spellar

spellar~spellCheckPost(post, callback)

Spell-check the post, sending an edit if anything has been changed

Kind: inner method of spellar

Param	Type	Description
post	object	An object representing the post
callback	function	The callback to use once the action is complete