External module "server/decorators/router"

Index

Variables

routes

Functions

Variables

Const routes

routes: IRoute

Functions

After

After(middlw: function): (Anonymous function)

- Defined in server/decorators/router.ts:113
Middleware to excute after the method

see

Create your middleware

Parameters
- middlw: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns (Anonymous function)

AfterAll

AfterAll(middlw: function): (Anonymous function)

- Defined in server/decorators/router.ts:58
Middleware to excute after all the endpoints

see

Create your middleware

Parameters
- middlw: function
  
  Function which is executed from the middleware
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns (Anonymous function)

Before

Before(middlw: function): (Anonymous function)

- Defined in server/decorators/router.ts:89
Middleware to excute bafore the method

see

Create your middleware

Parameters
- middlw: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns (Anonymous function)

BeforeAll

BeforeAll(middlw: function): (Anonymous function)

- Defined in server/decorators/router.ts:27
Middleware to excute bafore all the endpoints

see

Create your middleware

Parameters
- middlw: function
  
  Function which is executed from the middleware
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns (Anonymous function)

Delete

Delete(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:135
Endpoint method delete

Parameters
- path: string
  
  Path of the delete method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Endpoint

Endpoint(): (Anonymous function)

- Defined in server/decorators/router.ts:12
Decoration to add endpoint route

see

Create your enpoints

Returns (Anonymous function)

Get

Get(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:154
Endpoint method get

Parameters
- path: string
  
  Path of the get method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Head

Head(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:173
Endpoint method Head

Parameters
- path: string
  
  Path of the Head method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Options

Options(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:192
Endpoint method Options

Parameters
- path: string
  
  Path of the Options method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Patch

Patch(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:211
Endpoint method Patch

Parameters
- path: string
  
  Path of the Patch method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Post

Post(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:230
Endpoint method Post

Parameters
- path: string
  
  Path of the Post method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Put

Put(path: string, permission?: object): (Anonymous function)

- Defined in server/decorators/router.ts:249
Endpoint method Put

Parameters
- path: string
  
  Path of the Put method
- Optional permission: object
  - name: string
  - secret: string
Returns (Anonymous function)

Generated using TypeDoc