@cuser/express-middleware-rest
Status
curl -X POST \
http://localhost:8080/v1/message \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"topicId": "RANDOM_TOPIC_CID",
"content": {
"data": "Message content"
},
"user": {
"peerId": "RANDOM_PEER_ID",
"username": "exampleuser",
"avatar": "https://www.w3schools.com/howto/img_avatar.png"
}
}'
curl -X PATCH \
http://localhost:8080/v1/message \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"topicId": "RANDOM_TOPIC_CID",
"messageId": "message_id",
"content": {
"data": "Message content"
},
"user": {
"peerId": "RANDOM_PEER_ID",
"username": "exampleuser",
"avatar": "https://www.w3schools.com/howto/img_avatar.png"
}
}'
curl -X DELETE \
http://localhost:8080/v1/message \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"topicId": "RANDOM_TOPIC_CID",
"messageId": "message_id",
"user": {
"peerId": "RANDOM_PEER_ID",
"username": "exampleuser",
"avatar": "https://www.w3schools.com/howto/img_avatar.png"
}
}'
@cuser/express-middleware-rest
Index
Variables
- Router
- authGuard
- bodyParser
- createPublisher
- createReader
- debug
- defaultWrapper
- description
- name
- version
Functions
- createRestMiddleware
- createRestPublisherMiddleware
- createRestReaderMiddleware
- parseOpts
- swaggerRouter
- wrapper
Object literals
Variables
Router
• Const
Router: any = require('router')
Defined in express-middleware-rest/middleware.js:4
Defined in express-middleware-rest/publisher.js:8
Defined in express-middleware-rest/reader.js:6
authGuard
• authGuard: any
Defined in express-middleware-rest/publisher.js:10
bodyParser
• Const
bodyParser: any = require('body-parser')
Defined in express-middleware-rest/middleware.js:6
createPublisher
• Const
createPublisher: createPublisher = require('@cuser/publisher')
Defined in express-middleware-rest/publisher.js:9
createReader
• Const
createReader: createReader = require('@cuser/reader')
Defined in express-middleware-rest/reader.js:7
debug
• Const
debug: Debugger = require('debug')('cuser:server:rest')
Defined in express-middleware-rest/middleware.js:5
defaultWrapper
• Const
defaultWrapper: wrapper = require('./wrapper')
Defined in express-middleware-rest/publisher.js:11
Defined in express-middleware-rest/reader.js:8
description
• description: string
Defined in express-middleware-rest/middleware.js:7
name
• name: string
Defined in express-middleware-rest/middleware.js:7
version
• version: string
Defined in express-middleware-rest/middleware.js:7
Functions
createRestMiddleware
▸ Const
createRestMiddleware(core
: CuserCore, auth
: CuserAuth, opts
: CuserExpressMiddlewareRestOptions): any
Defined in express-middleware-rest/middleware.js:33
Parameters:
Name | Type |
---|---|
core |
CuserCore |
auth |
CuserAuth |
opts |
CuserExpressMiddlewareRestOptions |
Returns: any
createRestPublisherMiddleware
▸ Const
createRestPublisherMiddleware(core
: CuserCore, auth
: CuserAuth, opts?
: any): any
Defined in express-middleware-rest/publisher.js:25
Parameters:
Name | Type | Default value |
---|---|---|
core |
CuserCore | - |
auth |
CuserAuth | - |
opts |
any | {} |
Returns: any
createRestReaderMiddleware
▸ Const
createRestReaderMiddleware(core
: CuserCore, opts?
: CuserExpressMiddlewareRestReaderOptions & CuserReaderOptions): any
Defined in express-middleware-rest/reader.js:21
Parameters:
Name | Type | Default value |
---|---|---|
core |
CuserCore | - |
opts |
CuserExpressMiddlewareRestReaderOptions & CuserReaderOptions | {} |
Returns: any
parseOpts
▸ Const
parseOpts(opts
: any): any
Defined in express-middleware-rest/middleware.js:17
Parameters:
Name | Type |
---|---|
opts |
any |
Returns: any
swaggerRouter
▸ Const
swaggerRouter(opts
: any): any
Defined in express-middleware-rest/swagger.js:6
Parameters:
Name | Type |
---|---|
opts |
any |
Returns: any
wrapper
▸ Const
wrapper(wrappedHandler
: Function): any
Defined in express-middleware-rest/wrapper.js:14
Parameters:
Name | Type |
---|---|
wrappedHandler |
Function |
Returns: any
Object literals
defaults
Const
defaults: object
Defined in express-middleware-rest/middleware.js:10
Properties:
Name | Type | Value |
---|---|---|
mount |
string | "/rest" |
publisher |
boolean | true |
reader |
boolean | false |
ui |
boolean | process.env.NODE_ENV !== 'production' |