Index

Modules: dictionary, dictionaryserver, parser, sequel, sql/queries, website.

API symbols

Buttons:

• website: enum Buttons

constructHash:

• dictionary: proc constructHash(word, definition: string): string

contentBoxId:

• website: const contentBoxId

css:

• website: const css

DatabaseError:

• sequel: object DatabaseError

databaseName:

• sequel: const databaseName

databaseSwitch:

• sequel: const databaseSwitch

decode:

• parser: proc decode(encoded: string): string

defaultJavascriptNotAvailable:

• website: const defaultJavascriptNotAvailable

Definition:

• sequel: tuple Definition

DuplicateHash:

• sequel: object DuplicateHash

getAllDefinitions:

• sequel: proc getAllDefinitions(): seq[Definition]

getDefinitionById:

• sequel: proc getDefinitionById(id: string | int): Option[Definition]

getDefinitionsByName:

• sequel: proc getDefinitionsByName(name: string): seq[Definition]

getDefinitionsBySqlStatement:

• sequel: proc getDefinitionsBySqlStatement(statement: SqlQuery; args: varargs[string]): seq[ Definition]

getHtmlDefinition:

• website: proc getHtmlDefinition(definition: Definition): HtmlElement

handleNewDefinition:

• dictionaryserver: proc handleNewDefinition(request: Request; path: seq[string]): owned(Future[void])

handleRequest:

• dictionaryserver: proc handleRequest(request: Request): owned(Future[void])

htmlDisplayMultipleDefinitions:

• website: proc htmlDisplayMultipleDefinitions(query: string = ""): Future[HtmlDocument]

htmlDisplaySingleDefinition:

• website: proc htmlDisplaySingleDefinition(id: int): Future[HtmlDocument]

htmlIndex:

• website: proc htmlIndex(): Future[HtmlDocument]

htmlSubmitDefinition:

• website: proc htmlSubmitDefinition(): Future[HtmlDocument]

htmlSubmitSuccess:

• website: proc htmlSubmitSuccess(word: string): Future[HtmlDocument]

httpErrorPage:

• website: proc httpErrorPage(details: string): Future[HtmlDocument]

initDatabaseTables:

• sequel: proc initDatabaseTables()

InvalidData:

• sequel: object InvalidData

javascriptLocation:

• website: const javascriptLocation

javascriptScripts:

• website: const javascriptScripts

newDefinition:

• sequel: proc newDefinition(definition: Definition; hash: string)
• sequel: proc newDefinition(word, description: string; author: string = ""; hash: string)

newPage:

• website: proc newPage(name, description: string; generateContentBox: bool = true; scriptPath: string = ""): HtmlDocument

ParsedSubmitField:

• parser: tuple ParsedSubmitField

parseHtmlBody:

• parser: proc parseHtmlBody(body: string): Table[string, string]

parseHtmlBodySubmit:

• parser: proc parseHtmlBodySubmit(body: string): ParsedSubmitField

port:

• dictionaryserver: const port

replaceAllSussyCharacters:

• dictionary: proc replaceAllSussyCharacters(decoded: string): string

replaceAllSussyCharactersDecodeEncode:

• dictionary: proc replaceAllSussyCharactersDecodeEncode(encoded: string): string

replaceCharacters:

• dictionary: const replaceCharacters

responseHeaders:

• dictionaryserver: proc responseHeaders(): HttpHeaders

runServer:

• dictionaryserver: proc runServer(): owned(Future[void])

searchBarId:

• website: const searchBarId

serveDefinitionById:

• dictionaryserver: proc serveDefinitionById(request: Request; path: seq[string]): owned(Future[void])

serveDefinitions:

• dictionaryserver: proc serveDefinitions(request: Request; path: seq[string]): owned(Future[void])

serveErrorPage:

• dictionaryserver: proc serveErrorPage(request: Request; path: seq[string]; description: string; httpCode: HttpCode = Http400): owned(Future[void])

serveIndex:

• dictionaryserver: proc serveIndex(request: Request; path: seq[string]): owned(Future[void])

serveNewEntryConstruct:

• dictionaryserver: proc serveNewEntryConstruct(request: Request; path: seq[string]): owned( Future[void])

sqlGetAllDefinitions:

• queries: const sqlGetAllDefinitions

sqlGetDefinitionById:

• queries: const sqlGetDefinitionById

sqlGetDefinitionsByName:

• queries: const sqlGetDefinitionsByName

sqlGetEntriesByHash:

• queries: const sqlGetEntriesByHash

sqlInitTableDefinitions:

• queries: const sqlInitTableDefinitions

sqlInitTables:

• queries: const sqlInitTables

sqlNewEntry:

• queries: const sqlNewEntry

sqlNewEntryAnonymous:

• queries: const sqlNewEntryAnonymous

sqlNewEntryHash:

• queries: const sqlNewEntryHash

SubmitRequest:

• dictionary: object SubmitRequest

toDefinition:

• sequel: proc toDefinition(row: Row): Definition

toDefinitions:

• sequel: proc toDefinitions(rows: seq[Row]): seq[Definition]
• website: Buttons.toDefinitions

toIndex:

• website: Buttons.toIndex

toSubmitDefinitions:

• website: Buttons.toSubmitDefinitions

validateNewEntryAndCommit:

• dictionary: proc validateNewEntryAndCommit(word, definition, author: string): Future[ ValidationResponse]

ValidationResponse:

• dictionary: tuple ValidationResponse

withDatabase:

• sequel: template withDatabase(db: untyped; body: untyped)