JSDoc: Class: BookController

Constructor

new BookController()

Create a book controller.

Source:

controllers/BookController.js, line 6

Methods

(async) byAuthor(authorId) → {Promise:.<Array:.<object:>>}

Get books by author.

Parameters:

Name	Type	Description
`authorId`	number

Source:

controllers/BookController.js, line 163

Returns:

Type: Promise:.<Array:.<object:>>

(async) byId(id) → {Promise:.<object:>}

Get a book by id.

Parameters:

Name	Type	Description
`id`	number

Source:

controllers/BookController.js, line 18

Returns:

Type: Promise:.<object:>

(async) byTerm(termId) → {Promise:.<Array:.<object:>>}

Get books by term.

Parameters:

Name	Type	Description
`termId`	number

Source:

controllers/BookController.js, line 175

Returns:

Type: Promise:.<Array:.<object:>>

(async) byTitle(title) → {Promise:.<object:>}

Get a book by title.

Parameters:

Name	Type	Description
`title`	string

Source:

controllers/BookController.js, line 33

Returns:

Type: Promise:.<object:>

(async) getCoverURL(id) → {Promise:.<(string:|null:)>}

Get the cover URL of a book.

Parameters:

Name	Type	Description
`id`	number

Source:

controllers/BookController.js, line 126

Returns:

Type: Promise:.<(string:|null:)>

(async) insert(title, subtitle, publicationDate) → {Promise:.<object:>}

Insert a book.

Parameters:

Name	Type	Description
`title`	string
`subtitle`	string
`publicationDate`	date

Source:

controllers/BookController.js, line 189

Returns:

Type: Promise:.<object:>

(async) searchByOCRElements(ocrElements) → {Promise:.<Array:.<object:>>}

Search books using OCR elements.

Parameters:

Name	Type	Description
`ocrElements`	Array:.<string:>

Source:

controllers/BookController.js, line 74

Returns:

Type: Promise:.<Array:.<object:>>

(async) searchByTitle(title, amount) → {Promise:.<Array:.<object:>>}

Search books by title.

Parameters:

Name	Type	Description
`title`	string
`amount`	number

Source:

controllers/BookController.js, line 49

Returns:

Type: Promise:.<Array:.<object:>>

(async) searchByTitleAndAuthorName(title, authorName) → {Promise:.<Array:.<object:>>}

Search books by title and author name.

Parameters:

Name	Type	Description
`title`	string
`authorName`	string

Source:

controllers/BookController.js, line 87

Returns:

Type: Promise:.<Array:.<object:>>

(async) searchByTitleNatural(title, amount) → {Promise:.<Array:.<object:>>}

Search books by title using natural language mode.

Parameters:

Name	Type	Description
`title`	string
`amount`	number

Source:

controllers/BookController.js, line 62

Returns:

Type: Promise:.<Array:.<object:>>