Class RsterApiModule<NAME, MODULES, METHODS>

constructor

• new RsterApiModule<NAME, MODULES, METHODS>(name, description, modules, methods, httpPath?, httpMethod?): RsterApiModule<NAME, MODULES, METHODS>

• The constructor of the RsterApiModule class.

  Type Parameters

  • NAME extends string

  • MODULES extends {
        [key: string]: RsterApiModule<typeof key, any, any>;
    }

  • METHODS extends {
        [key: string]: AnyRsterApiMethod;
    }

  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>

Readonly description

Optional Readonly httpMethod

Optional Readonly httpPath

Readonly methodList

Readonly methods

Readonly moduleList

Readonly modules

Readonly name

json

• json(): RsterApiModuleJson

• The json representation of the module.

  Returns RsterApiModuleJson

  The json representation of the module.

  See

  RsterApiModuleJson

native

• native(): RemoveNeverProperties<{
      [key in string | number | symbol]: key extends keyof METHODS
          ? ReturnType<MODULES[key]["native"]> & ReturnType<METHODS[key]["native"]>
          : ReturnType<MODULES[key]["native"]>
  }> & RemoveNeverProperties<{
      [key in string | number | symbol]: key extends keyof MODULES
          ? never
          : ReturnType<METHODS[key]["native"]>
  }>

• Returns the native representation of the module.

  Returns RemoveNeverProperties<{
      [key in string | number | symbol]: key extends keyof METHODS
          ? ReturnType<MODULES[key]["native"]> & ReturnType<METHODS[key]["native"]>
          : ReturnType<MODULES[key]["native"]>
  }> & RemoveNeverProperties<{
      [key in string | number | symbol]: key extends keyof MODULES
          ? never
          : ReturnType<METHODS[key]["native"]>
  }>

  The native representation of the module.

rest

• rest(ctx?): void

• Adds the module to the context.

  Parameters

  • Optional ctx: Context

    The context to add the module to.

  Returns void

  See

  Context