Protontype Reference API
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Router
Mock
base
Url
express
model
Instances
proton
Application
route
Confgs
router
router
Middlewares
add
Route
Config
create
custom
Router
destroy
find
All
find
One
get
Base
Url
get
Model
get
Model
Instances
get
Route
Configs
get
Router
get
Router
Middlewares
init
route
Delete
route
Head
route
List
route
Options
route
Patch
route
Post
route
Put
route
Test
send
Error
Message
update
Hierarchy
BaseCrudRouter
RouterMock
Index
Properties
base
Url
express
model
Instances
proton
Application
route
Confgs
router
router
Middlewares
Methods
add
Route
Config
create
custom
Router
destroy
find
All
find
One
get
Base
Url
get
Model
get
Model
Instances
get
Route
Configs
get
Router
get
Router
Middlewares
init
route
Delete
route
Head
route
List
route
Options
route
Patch
route
Post
route
Put
route
Test
send
Error
Message
update
Properties
Protected
base
Url
base
Url
:
string
Protected
express
express
:
Express.Application
Protected
model
Instances
model
Instances
:
BaseModel
<
any
>
[]
Protected
proton
Application
proton
Application
:
ProtonApplication
Protected
route
Confgs
route
Confgs
:
RouteConfig
[]
Protected
router
router
:
Express.Router
Protected
router
Middlewares
router
Middlewares
:
ProtonMiddleware
[]
Methods
add
Route
Config
add
Route
Config
(
config
:
RouteConfig
)
:
void
Parameters
config:
RouteConfig
Returns
void
create
create
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
custom
Router
custom
Router
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
destroy
destroy
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
find
All
find
All
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
find
One
find
One
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
get
Base
Url
get
Base
Url
(
)
:
string
Returns
string
get
Model
get
Model<T>
(
modelName
:
string
)
:
T
Type parameters
T
:
BaseModel
<
any
>
Parameters
modelName:
string
Returns
T
get
Model
Instances
get
Model
Instances
(
)
:
BaseModel
<
any
>
[]
Returns
BaseModel
<
any
>
[]
get
Route
Configs
get
Route
Configs
(
)
:
RouteConfig
[]
Returns
RouteConfig
[]
get
Router
get
Router
(
)
:
Express.Router
Returns
Express.Router
get
Router
Middlewares
get
Router
Middlewares
(
)
:
ProtonMiddleware
[]
Returns
ProtonMiddleware
[]
init
init
(
protonApplication
:
ProtonApplication
)
:
void
Parameters
protonApplication:
ProtonApplication
Returns
void
route
Delete
route
Delete
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
Head
route
Head
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
List
route
List
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
Options
route
Options
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
Patch
route
Patch
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
Post
route
Post
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
Put
route
Put
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
route
Test
route
Test
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
send
Error
Message
send
Error
Message
(
res
:
any
, error
:
any
)
:
void
Parameters
res:
any
error:
any
Returns
void
update
update
(
params
:
RouterFunctionParams
)
:
void
Parameters
params:
RouterFunctionParams
Returns
void
Generated using
TypeDoc