Interface RsterApiMethodJson

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

See

  • RsterApiMethod.json
  • RsterApiMethod
  • RsterApiJson
  • RsterApiModuleJson

Hierarchy

  • RsterApiMethodJson

Properties

declaration description httpMethod? httpPath? name

Properties

declaration

declaration: {
    expectBody?: {
        [key: string]: unknown;
    };
    expectParams?: {
        [key: string]: unknown;
    };
    expectQuery?: {
        [key: string]: unknown;
    };
    returns?: unknown;
}

The declaration of the method.

Type declaration

  • Optional expectBody?: {
        [key: string]: unknown;
    }

    The declaration of the body of the request.

    See

    • ParameterDeclaration.expectBody
    • ParameterDeclaration
    • [key: string]: unknown
  • Optional expectParams?: {
        [key: string]: unknown;
    }

    The declaration of the params of the request.

    See

    • ParameterDeclaration.expectParams
    • ParameterDeclaration
    • [key: string]: unknown
  • Optional expectQuery?: {
        [key: string]: unknown;
    }

    The declaration of the query of the request.

    See

    • ParameterDeclaration.expectQuery
    • ParameterDeclaration
    • [key: string]: unknown
  • Optional returns?: unknown

    The declaration of the return value of the method.

    See

    • ParameterDeclaration.returns
    • ParameterDeclaration

See

  • RsterApiMethod.declaration
  • ParameterDeclaration

description

description: string[]

The description of the method.

See

RsterApiMethod.description

Optional httpMethod

httpMethod?: Method

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

See

  • RsterApiMethod.httpMethod
  • Method

Optional httpPath

httpPath?: string

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

See

RsterApiMethod.httpPath

name

name: string

The name of the method.

See

RsterApiMethod.name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc