stichy.js docs
A parser and wrapper for the stichy.js docs.
Usage
Doc
const Doc = require('stichy.js-docs')
Doc.fetch(sourceName[, options])
Fetches and parses the docs for the given project.
sourceName
can be either of the predefined values (stable
, main
)
or an URL which will return the raw generated docs (e.g https://raw.githubusercontent.com/stichyjs/stichy.js/main/docs.json ).
Once a documentation is fetched it will be cached. Use options.force
to avoid this behavior.
Params:
name | type | required |
---|---|---|
sourceName | string | yes |
options | object | no |
Returns: Promise<Doc?>
const doc = await Doc.fetch('master')
const doc = await Doc.fetch('akairo-master', { force: true })
const doc = await Doc.fetch(
'https://raw.githubusercontent.com/stichyjs/stichy.js/main/docs.json',
{ force: true }
)
Doc#get(parent[, child1[ ...[, childN]]])
Gets documention for one element. Multiple properties/methods can be chained. Params:
name | type | required |
---|---|---|
parent | string | yes |
...children | string | no |
Returns: DocElement?
doc.get('message')
doc.get('message', 'guild')
doc.get('message', 'guild', 'members')
Doc#search(query)
Searches the documentation using fuzzy search for the given query and returns top 10 hits.
Params:
name | type | required |
---|---|---|
query | string | yes |
Returns: Array<DocElement>?
Doc#resolveEmbed(query)
Tries to resolve the query into a DocElement
using Doc#get
. The search terms are expected to be separated by #
or .
, example: message#pin
. If an element cannot be resolved, falls back to Doc#search
. The result is then formatted into an object representing a Discord embed which can be sent directly to a Discord channel.
Params:
name | type | required |
---|---|---|
query | string | yes |
Returns: object?