Class FilterPresetController

Abstract class representing a base controller with commonly used methods for handling requests and parameters. This class extends the ControllerInstance and provides utility methods for parameter retrieval and parsing.

Hierarchy (View Summary)

Constructors

constructor

Methods

create delete getAll getById onDestroy? update getId getParam getParams

Constructors

constructor

Methods

create

delete

getAll

getById

OptionalonDestroy

  • onDestroy(): void

  • Optional method to perform teardown or clean-up actions specific to the instance. It is invoked when the instance is being destroyed. This method does not take any parameters and does not return any value.

    Returns void

update

StaticgetId

  • getId(request: Request, shouldThrow?: boolean): number

  • Retrieves and parses the "id" parameter from the given request object.

    Parameters

    • request: Request

      The request object containing parameters.

    • OptionalshouldThrow: boolean = true

      Determines whether an exception should be thrown if the "id" parameter is missing.

    Returns number

    The parsed integer value of the "id" parameter if present, or null if not present and shouldThrow is false.

    Throws

    Throws an exception if the "id" parameter is missing and shouldThrow is true.

StaticgetParam

  • getParam<T extends string | number | boolean | Moment>(
        request: Request,
        key: string,
        defaultValue: T,
    ): T

  • Type Parameters

    • T extends string | number | boolean | Moment

    Parameters

    • request: Request

      {Express.Request}

    • key: string

      {string}

    • defaultValue: T

      {T}

    Returns T

    Description

    Tries to get parameter specified by key from requests route parameters. If the parameter is not found in the request, the default value will be returned.

StaticgetParams

  • getParams<T extends string | number | boolean | Moment>(
        request: Request,
        paramDefinition: ParamDefinition<T>,
    ): ParamDefinition<T>

  • Type Parameters

    • T extends string | number | boolean | Moment

    Parameters

    • request: Request

      {Express.Request}

    • paramDefinition: ParamDefinition<T>

      {ParamDefinition}

    Returns ParamDefinition<T>

    Description

    Tries to get parameters specified in paramDefinition from requests route parameters. If a parameter is not found in the request, the parameter is set to the default value specified in paramDefinition.

Settings

Member Visibility

On This Page

Constructors
Methods