Function module

module<NAME, MODULES, METHODS>(name, description, modules, methods, httpPath?, httpMethod?): RsterApiModule<NAME, MODULES, METHODS>
Shortcut function to create a RsterApiModule object.
Type Parameters
- NAME extends string
- MODULES extends {
  [key: string]: RsterApiModule<typeof key, any, any>;
  }
- METHODS extends {
  [key: string]: AnyRsterApiMethod<typeof key>;
  }
Parameters
- name: NAME
  The name of the module.
- description: string[]
  The description of the module.
- modules: MODULES
  The modules of the module.
- methods: METHODS
  The methods of the module.
- Optional httpPath: string
  The http path of the module. Will be joined with the parent module's path.
- Optional httpMethod: Method
  The http method of the module.
Returns RsterApiModule<NAME, MODULES, METHODS>
A new RsterApiModule object.
- Defined in module.ts:231

Generated using TypeDoc