Class RsterApi<NAME, MODULES, METHODS>

constructor

• new RsterApi<NAME, MODULES, METHODS>(name, description, modules, methods): RsterApi<NAME, MODULES, METHODS>

• The constructor of the RsterApi class.

  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 api.

  • description: string[]

    The description of the api.

  • modules: MODULES

    The modules of the api.

  • methods: METHODS

    The methods of the api.

  Returns RsterApi<NAME, MODULES, METHODS>

Readonly description

Readonly methodList

Readonly methods

Readonly moduleList

Readonly modules

Readonly name

json

• json(): RsterApiJson

• Returns the json representation of the api.

  Returns RsterApiJson

  See

  RsterApiJson

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 api as a native object. This is userful if you want to use the api definition as functions on your server-side, so you don't have to define the functionality in another place

  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"]>
  }>

rest

• rest(): RestfulApi

• Returns the api as a restful api. RestfulApi

  Returns RestfulApi

  See

  RestfulApi