Kottster Packages API Reference
    Preparing search index...

    Interface KottsterAppOptions

    interface KottsterAppOptions {
        configureExpressApp?: (app: Express) => void;
        identityProvider?: IdentityProvider;
        kottsterApiToken?: string;
        postAuthMiddleware?: PostAuthMiddleware;
        secretKey?: string;
    }
    Index

    Properties

    configureExpressApp? identityProvider? kottsterApiToken? postAuthMiddleware? secretKey?

    Properties

    configureExpressApp?: (app: Express) => void

    Allows developers to customize the Express app instance.

    Useful for: • adding custom middleware • modifying server settings • enabling CORS, proxies, cookies • registering additional routes

    Type Declaration

      • (app: Express): void

      • Parameters

        • app: Express

          The Express application instance

        Returns void

    identityProvider?: IdentityProvider

    The identity provider configuration

    kottsterApiToken?: string

    The Kottster API token for the appen. If not provided, some features that require server-side requests to Kottster API will not work (e.g. sql query generation, AI features, etc.)

    postAuthMiddleware?: PostAuthMiddleware

    Custom validation middleware. This middleware will be called after the JWT token is validated. You can use it to perform additional checks or modify the request object.

    https://kottster.app/docs/security/authentication#custom-validation-middleware
    secretKey?: string

    The secret key used to sign JWT tokens

    Settings

    Member Visibility

    On This Page

    Properties