Function api

api<NAME, MODULES, METHODS>(name, description, modules, methods): RsterApi<NAME, MODULES, METHODS>
Shortcut function to create a RsterApi 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 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>
A new RsterApi object.
- Defined in api.ts:183

Generated using TypeDoc