Type Alias APIConfig

APIConfig: {
    caseConversion?: {
        in: "snake" | "camel";
        out: "snake" | "camel";
    };
    client?: PgClientParams;
    pagination?: {
        defaultLimit?: number;
        defaultPage?: number;
    };
    port?: number;
    prefix?: `/${string}`;
    tokenHeader?: string;
}

Type declaration

  • OptionalcaseConversion?: {
        in: "snake" | "camel";
        out: "snake" | "camel";
    }

    Description

    The case conversion to use for the API

    Example

    { in: 'snake', out: 'camel' }
    • in: "snake" | "camel"
    • out: "snake" | "camel"
  • Optionalclient?: PgClientParams
  • Optionalpagination?: {
        defaultLimit?: number;
        defaultPage?: number;
    }

    Description

    The pagination to use for the API

    Example

    { defaultPage: 1, defaultLimit: 10 }
    • OptionaldefaultLimit?: number
    • OptionaldefaultPage?: number
  • Optionalport?: number

    Description

    The port to run the API on

  • Optionalprefix?: `/${string}`

    Description

    The prefix to use for the API

    Example

    '/api'

    Default

    '/api'
  • OptionaltokenHeader?: string

    Description

    The header to use for the API

    Example

    'Authorization'

    Default

    'Authorization'

Settings

Member Visibility