tedxku-backend 1.0.0 | Documentation

tedxku-backend

1.0.0

DefaultController
loader ▸
- Static members
- .by_model
- .by_name
Models ▸
- Static members
- .BannerModel
- .ConceptModel
- .EventModel
- .LocationModel
- .PartnerModel
- .SpeakerModel
- .VolunteerModel
DefaultModel ▸
- Instance members
- #mongoose
- #DEFAULT_LIMIT
- #name
- #name
- #low_name
- #create
- #list
- #retrieve
- #update
- #delete
- #delete_by_condition
- #count
- #random
- #clear_db
ServerSetting

Need help reading this?

DefaultController

new DefaultController(model: any, functions: any)

Parameters

model (any)

functions

(any
            = [])

loader

object of utils function.

loader

Version: 0.2.0

Author: Kamontat Chantrachirathumrong

Parameters

by_model (Function) load function by input model object

by_name (Function) load function by input name of the model object

Static Members

▸ by_model(model)

auto load fixture from db/fixtures/index by input model object

by_model(model: Model): Promise<null>

Parameters

model (Model) model object from models folder

Returns

Promise<null>: promise of void value

▸ by_name

auto load fixture from db/fixtures/index by input model name

by_name

Parameters

model (string) model name should be lower case

Returns

Promise<null>: promise of void value

Models

database model

Models

Type: Object

Static Members

▸ BannerModel

BannerModel

Type: DefaultModel

Deprecated: Banner model, create by use default model class ( DefaultModel ).

Type 1 - text banner
Type 2 - link banner
Type 3 - image banner

Database structure

column_name	type	require?
title	string	true
type	1,2,3	true
header	string	if type=1
footer	string	if type=1
detail	string	if type=2
link	string	if type=2
background	string	false

Example

const banner = require('./models').banner

▸ ConceptModel

Concept model, create by use default model class (DefaultModel)

Database structure

column_name	type	require?
title	string	false
detail	string	false

ConceptModel

Type: DefaultModel

Example

const concept = require('./models').concept

▸ EventModel

Event model, create by use default model class (DefaultModel).

Database structure

column_name	type	require?	unique?	index?
year	number	true	true	true
datetime	date	false	false	false
locations	obj-id[]	false	false	false
speakers	obj-id[]	false	false	false
members	obj-id[]	false	false	false
banners	obj-id[]	false	false	false

EventModel

Type: DefaultModel

Example

const event = require('./models').event

▸ LocationModel

Location model, create by use default model class (DefaultModel)

Database structure

column_name	type	require?
name	string	true
detail	string	false
lat	number	true
lon	number	true

LocationModel

Type: DefaultModel

Example

const location = require('./models').location

▸ PartnerModel

Partner model, create by use default model class (DefaultModel)

Database structure

column_name	type	require?
name	string	false
image	string	false
url	string	false

PartnerModel

Type: DefaultModel

Example

const partner = require('./models').partner

▸ SpeakerModel

Speaker model, create by use default model class (DefaultModel)

Database structure

column_name	type	require?
name	string	true
description	string	false
topic	string	false
image	string	false
youtube_id	string	false

SpeakerModel

Type: DefaultModel

Example

const speaker = require('./models').speaker

▸ VolunteerModel

Volunteer model, create by use default model class (DefaultModel)

Database structure

column_name	type	require?
name	string	true
position	string	true
image	string	false

VolunteerModel

Type: DefaultModel

Example

const volunteer = require('./models').volunteer

DefaultModel

create mongo schema and model, More mongoosejs

new DefaultModel(database_name: string, database_columns: Object, database_options: Object)

Version: 0.2.0-beta.3

Author: Kamontat Chantrachirathumrong

Parameters

database_name (string) database name

database_columns (Object) column inside database

database_options (Object) option of Schema creator

Instance Members

▸ mongoose

mongoose instance

mongoose

Returns

Object: mongooes

▸ DEFAULT_LIMIT

default limit of list model

DEFAULT_LIMIT

Returns

number: 15

▸ name

get model name

name

Returns

string: database name

▸ name

setter of model name

name

Parameters

name (string) new name

▸ low_name

get model name as lower case

low_name

Returns

string: database name

▸ create(parameters)

create new model

create(parameters: Object): Promise<Model>

Parameters

parameters (Object) model columns

Returns

Promise<Model>: promise of mongo model

▸ list(next, option)

list row in database, by limitation and next

list(next: number, option: Object): Promise<Array<Model>>

Parameters

next (number) next element, More mongodb-skip

option

(Object
            = {})

option for list

Name	Description
option.default_limit `(number \| string)`	overide default limit, input 'all' to list every result
option.filter `Object`	filter result, must be JSON which key is same as column

Returns

Promise<Array<Model>>: promise of list of mongo model

▸ retrieve(id)

get one model specify by _id

retrieve(id: string): Promise<Model>

Parameters

id (string) model id

Returns

Promise<Model>: promise of mongo model

▸ update(id, body)

update model that have id same as input id

update(id: string, body: Object): Promise<Model>

Parameters

id (string) input id

body (Object) update column

Returns

Promise<Model>: promise of new mongo model

▸ delete(id)

delete one model specify by _id

delete(id: string): Promise<Null>

Parameters

id (string) model id

Returns

Promise<Null>: promise of empty

▸ delete_by_condition(condition)

remove row by using condition

delete_by_condition(condition: Object)

Parameters

condition (Object) remving condition

▸ count(condition)

count element model by [condition]

count(condition: Object): Promise<Null>

Parameters

condition

(Object
            = {})

filter model and counting Model.count

Returns

Promise<Null>: promise of count number

▸ random(filter, fields, options)

random element using mongoose-simple-random

random(filter: Object, fields: Object, options: Object): Promise<Array<Object>>

Parameters

filter

(Object
            = {})

filter result

fields

(Object
            = {})

choose the result output

options

(Object
            = {})

resut management

Name	Description
options.skip `number`	skip result, same as next
options.limit `number`	limit the result, default is array size 1

Returns

Promise<Array<Object>>: promise of the random object as array

▸ clear_db()

clear all row this model (Table)

clear_db(): Promise<null>

Returns

Promise<null>: promise of null

ServerSetting

config file for setting express application

ServerSetting

Version: 0.3.0

Author: Kamontat Chantrachirathumrong

Parameters

expressApp (Object) express app

Logger (Object) logger for log