Global

Methods

(async) execute_query(query_blocks) → {Array}

[execute_query Core function to get results from the Jisho API]
Parameters:
Name Type Description
query_blocks Array [Query words to send to the API]
Source:
Returns:
[Array of jisho results objects]
Type
Array

(async) extractJishoData(response_json) → {Array}

[extractJishoData Converts Jisho API response records into JishoRecord entries]
Parameters:
Name Type Description
response_json Array [array of records in a Jisho API response]
Source:
Returns:
[array of JishoRecord Objects]
Type
Array

extractJLPTLevel(entry) → {string}

[extractJLPTLevel Extract the JLPT level from a Jisho API response record]
Parameters:
Name Type Description
entry Object [record in a Jisho API response]
Source:
Returns:
[JLPT level in the format 'Nx']
Type
string

extractMeanings(entry) → {Array}

[extractMeanings Extract a word's meanings from a Jisho API response record]
Parameters:
Name Type Description
entry Object [record in a Jisho API response]
Source:
Returns:
[array of unique word meanings]
Type
Array

extractReading(entry) → {string}

[extractReading Extract the word reading from a Jisho API response record]
Parameters:
Name Type Description
entry Object [record in a Jisho API response]
Source:
Returns:
[reading]
Type
string

extractWaniKaniLevel(entry) → {string}

[extractWaniKaniLevel Extract the WaniKani level from a Jisho API response record]
Parameters:
Name Type Description
entry Object [record in a Jisho API response]
Source:
Returns:
[WaniKani level]
Type
string

extractWordTypes(entry) → {Array}

[extractWordTypes Extract a word's grammatical types from a Jisho API response record]
Parameters:
Name Type Description
entry Object [record in a Jisho API response]
Source:
Returns:
[array of unique word grammatical types]
Type
Array

(async) getCommonEntries(query) → {Array}

[getCommonEntries Get only common entries for a given query]
Parameters:
Name Type Description
query string [Query word to send to the API]
Source:
Returns:
[Array of JishoRecord objects]
Type
Array

(async) getEntries(query, is_commmon) → {Array}

[getEntries Gets records from the Jisho Web API]
Parameters:
Name Type Description
query string [Query word to send to the API]
is_commmon boolean [Flag to query for common vocabulary]
Source:
Returns:
[Array of JishoRecord objects]
Type
Array

(async) getEntriesEndingWith(query, is_commmon) → {Array}

[getEntriesEndingWith Get results for a word ending with a given query]
Parameters:
Name Type Description
query string [Query word to send to the API]
is_commmon boolean [Flag to query for common vocabulary]
Source:
Returns:
[Array of JishoRecord objects]
Type
Array

(async) getEntriesJLPTLevel(query, jlpt_level) → {Array}

[getEntriesJLPTLevel Get results for a given JLPT level]
Parameters:
Name Type Description
query string [Query word to send to the API]
jlpt_level string [JLPT level in the Nx or nx format]
Source:
Returns:
[Array of JishoRecord objects]
Type
Array

(async) getEntriesStartingWith(query, is_commmon) → {Array}

[getEntriesStartingWith Get results for a word starting with a given query]
Parameters:
Name Type Description
query string [Query word to send to the API]
is_commmon boolean [Flag to query for common vocabulary]
Source:
Returns:
[Array of JishoRecord objects]
Type
Array

(async) getEntriesWasei(query, is_commmon) → {Array}

[getEntriesWasei Get wasei eigo results for a given query]
Parameters:
Name Type Description
query string [Query word to send to the API]
is_commmon boolean [Flag to query for common vocabulary]
Source:
Returns:
[Array of JishoRecord objects]
Type
Array

JishoRecord(entry) → {Object}

[JishoRecord Converts an entry from the Jisho Web API into a simplified form]
Parameters:
Name Type Description
entry Object [Entry from the Jisho Web API]
Source:
Returns:
[Array of jisho results objects]
Type
Object