Interface RsterApiModuleJson

A type for the json representation of the module class. Returned by the json method, used to get info about the module.

See

  • RsterApiModule.json
  • RsterApiModule
  • RsterApiJson
  • RsterApiModuleJson

Hierarchy

  • RsterApiModuleJson

Properties

description httpMethod? httpPath? methods modules name

Properties

description

description: string[]

The description of the module.

See

RsterApiModule.description

Optional httpMethod

httpMethod?: Method

The http method of the module. This is the condition for the module to be used for a request.

See

  • RsterApiModule.httpMethod
  • Method

Optional httpPath

httpPath?: string

The http path of the module. Will be joined with the parent module's path. This is the condition for the module to be used for a request.

See

RsterApiModule.httpPath

methods

methods: RsterApiMethodJson[]

The methods of the module.

See

  • RsterApiModule.methods
  • RsterApiMethodJson

modules

modules: RsterApiModuleJson[]

The modules of the module.

See

  • RsterApiModule.modules
  • RsterApiModuleJson

name

name: string

The name of the module.

See

RsterApiModule.name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc