Class RsterApiMethod<NAME, DECLARATION>

constructor

• new RsterApiMethod<NAME, DECLARATION>(name, description, declaration, httpPath?, httpMethod?, action?): RsterApiMethod<NAME, DECLARATION>

• The constructor of the RsterApiMethod class.

  Type Parameters

  • NAME extends string

  • DECLARATION extends ParameterDeclaration<AllowAnyTypeInformation, ParameterList, ParameterList, ParameterList, DECLARATION>

  Parameters

  • name: NAME

    The name of the method.

  • description: string[]

    The description of the method.

  • declaration: DECLARATION

    The declaration of the method.

  • Optional httpPath: string

    The http path of the method. Does not include the parent module's path, only the path for the method's condition. If not provided, it will be generated from the name and declaration.

  • Optional httpMethod: Method

    The http method of the method. If not provided, it will be defaulted to ALL.

  • Optional action: ActionFunction<DECLARATION>

    The action of the method. If not provided, it will be defaulted to a method that throws an error.

  Returns RsterApiMethod<NAME, DECLARATION>

Optional Readonly action

Readonly declaration

Readonly description

Optional Readonly httpMethod

Readonly httpPath

Readonly name

json

• json(): RsterApiMethodJson

• Get the json representation of the method. Used to get info about the method.

  Returns RsterApiMethodJson

  The json representation of the method.

  See

  RsterApiMethodJson

native

• native(): NeedsProperty<RemoveNeverProperties<{
          [key in string | number | symbol]: (NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["required"] extends false
              ? never
              : PrimitiveType<(NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["type"]>
      }> & Partial<RemoveNeverProperties<{
          [key in string | number | symbol]: (NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["required"] extends false
              ? PrimitiveType<(NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["type"]>
              : never
      }>>> extends true
      ? ((args) => RsterReturnType<DECLARATION>)
      : ((args?) => RsterReturnType<DECLARATION>)

• The native method of the method. This method can be used to call the method directly, without using the rest api.

  Returns NeedsProperty<RemoveNeverProperties<{
          [key in string | number | symbol]: (NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["required"] extends false
              ? never
              : PrimitiveType<(NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["type"]>
      }> & Partial<RemoveNeverProperties<{
          [key in string | number | symbol]: (NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["required"] extends false
              ? PrimitiveType<(NoUndefined<DECLARATION["expectBody"], Record<string, never>> & NoUndefined<DECLARATION["expectQuery"], Record<string, never>> & NoUndefined<DECLARATION["expectParams"], Record<string, never>>)[key]["type"]>
              : never
      }>>> extends true
      ? ((args) => RsterReturnType<DECLARATION>)
      : ((args?) => RsterReturnType<DECLARATION>)

  The native method of the method.

rest

• rest(ctx?): void

• Input the method into a Context object. This will add the method to the context, and it will be used for requests. Defaults to the current context.

  Parameters

  • Optional ctx: Context

    The context to add the method to. Defaults to the current context.

  Returns void