Class BaseEndpointGenerator

A base class for generating endpoint methods.

You can extend this class to create endpoint generators with helper methods, such as generate and getEndpointMethod.

Example

class MyEndpointGenerator extends BaseEndpointGenerator {
  // Custom methods and properties
}

const generator = new MyEndpointGenerator();
const methods = generator.generate();
// TODO: Use the generated methods

Index

Constructors

constructor

Methods

generate getEndpointMethod

Constructors

constructor

new BaseEndpointGenerator(): BaseEndpointGenerator
Returns BaseEndpointGenerator

Methods

generate

generate(): readonly EndpointMethod<any, any>[]
Generates endpoint methods for the current instance.

Returns readonly EndpointMethod<any, any>[]
An array of generated endpoint methods.
- Defined in src/apixlib/common/methods/Decorators.ts:458

getEndpointMethod

getEndpointMethod<
    Q extends RequestInputSchema = Record<string, never>,
    B extends RequestInputSchema = Record<string, never>,
>(
    method: string,
    httpMethod?: HttpMethod,
): undefined | EndpointMethod<Q, B>
Retrieves a specific endpoint method by its name and HTTP method.
Type Parameters
- Q extends RequestInputSchema = Record<string, never>
- B extends RequestInputSchema = Record<string, never>
Parameters
- method: string
  The name of the endpoint method.
- httpMethod: HttpMethod = 'GET'
  The HTTP method of the endpoint.
Returns undefined | EndpointMethod<Q, B>
The matching endpoint method or undefined if not found.
- Defined in src/apixlib/common/methods/Decorators.ts:443

Class BaseEndpointGenerator

Example

Index

Constructors

Methods

Constructors

constructor

Returns BaseEndpointGenerator

Methods

generate

Returns readonly EndpointMethod<any, any>[]

getEndpointMethod

Type Parameters

Parameters

Returns undefined | EndpointMethod<Q, B>

Settings

On This Page