import BaseContentController from 'pop-api/src/controllers/BaseContentController.js'

public class | source

BaseContentController

Extends:

IController → IContentController → BaseContentController

Implements:

IContentController

Indirect Implements:

IController

Base class for getting content from endpoints.

Test:

Constructor Summary

Public Constructor
public	constructor(options: Object) Create a new base content controller.

Member Summary

Public Members
public	basePath: string The base path for the routes.
public	service: ContentService The service of the content controller.

Method Summary

Public Methods
public	checkEmptyContent(res: ServerResponse, content: Object \| Array<Object>): Object Check if the content is empty or the length of the content array is zero.
public	createContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Create a new content item.
public	deleteContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Delete a content item.
public	getContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Get a content item based on the id.
public	getContents(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Array<string>, Error> Get all the available pages.
public	getPage(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Array<Object>, Error> Get content from one page.
public	getRandomContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Get a random item.
public	registerRoutes(router: Object, PopApi: PopApi): undefined Default method to register the routes.
public	sortContent(sort: string, order: number): Object Default method to sort the items.
public	updateContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Update the info of one content item.

Inherited Summary

From class IController
public abstract	registerRoutes(router: Object, PopApi: PopApi): undefined Default method to register the routes.

From class IContentController
public abstract	createContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Create a new content item.
public abstract	deleteContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Delete a content item.
public abstract	getContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Get a content item based on the id.
public abstract	getContents(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Array<string>, Object> Default method to get content pages.
public abstract	getPage(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Array<Object>, Error> Default method to get a page of content.
public abstract	getRandomContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Default method to get a random content item.
public abstract	sortContent(sort: string, order: number): Object Default method to sort the items.
public abstract	updateContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> Update the info of one content item.

Public Constructors

public constructor(options: Object) source

Create a new base content controller.

Params:

Name	Type	Attribute	Description
options	Object	nullable: false	The options for the base content controller.
options.basePath	string	nullable: false	The base path for the routes.
options.service	ContentService	nullable: false	The service for the content controller.

Test:

BaseContentController should check the attributes of the BaseContentController

Public Members

public basePath: string source

The base path for the routes.

public service: ContentService source

The service of the content controller.

Public Methods

public checkEmptyContent(res: ServerResponse, content: Object | Array<Object>): Object source

Check if the content is empty or the length of the content array is zero.

Params:

Name	Type	Attribute	Description
res	ServerResponse	nullable: false	The server response object.
content	Object \| Array<Object>	nullable: false	The content to check.

Return:

Object

Returns a 204 response if the content is empty, or a 200 response with the content if it is not empty.

public createContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> source

Create a new content item.

Override:

IContentController#createContent

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Object, Error>

The created content item.

Test:

public deleteContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> source

Delete a content item.

Override:

IContentController#deleteContent

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Object, Error>

The deleted content item

Test:

public getContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> source

Get a content item based on the id.

Override:

IContentController#getContent

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Object, Error>

The details of a single content item.

Test:

public getContents(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Array<string>, Error> source

Get all the available pages.

Override:

IContentController#getContents

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Array<string>, Error>

A list of pages which are available.

Test:

public getPage(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Array<Object>, Error> source

Get content from one page.

Override:

IContentController#getPage

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Array<Object>, Error>

The content of one page.

Test:

public getRandomContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> source

Get a random item.

Override:

IContentController#getRandomContent

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Object, Error>

A random item.

Test:

public registerRoutes(router: Object, PopApi: PopApi): undefined source

Default method to register the routes.

Override:

IController#registerRoutes

Params:

Name	Type	Attribute	Description
router	Object	nullable: false	The router to register the routes to.
PopApi	PopApi	nullable: false	The PopApi instance.

Return:

undefined

Test:

BaseContentController should register the routes with of the controller

public sortContent(sort: string, order: number): Object source

Default method to sort the items.

Override:

IContentController#sortContent

Params:

Name	Type	Attribute	Description
sort	string	nullable: false	The property to sort on.
order	number	nullable: false	The way to sort the property.

Return:

Object

The sort object.

public updateContent(req: IncomingMessage, res: ServerResponse, next: Function): Promise<Object, Error> source

Update the info of one content item.

Override:

IContentController#updateContent

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Promise<Object, Error>

The updated content item.