Interface IAppConfig

Server configuration.

interface IAppConfig {
    appDir?: string;
    auth?: ((session: Session<any>, next: ((err?: any) => void)) => void);
    autoprefixer?: any;
    babelTranspileModules?: string[];
    bundleAfterServerStart?: boolean;
    bundlePathRelative?: boolean;
    connectSocketAutomatically?: boolean;
    cookies?: {
        domain?: string;
        httpOnly?: boolean;
        sameSite?: string;
        secret?: string;
        secure?: boolean;
    };
    cookieSecret?: string;
    createMissingComponents?: boolean;
    cssDir?: string;
    dev?: boolean;
    entryFile?: string;
    envVars?: Record<string, any>;
    error?: {
        handler?: (<S>(err: any, req: IRequest<S>, res: IResponse, next: ((err?: any) => void)) => void);
        layout?: typeof Layout;
        page?: any;
    };
    errorHandler?: (<S>(err: any, req: IRequest<S>, res: IResponse, next: ((err?: any) => void)) => void);
    filename?: string;
    generatedComponentsExtension?:
        | "js"
        | "jsx"
        | "ts"
        | "tsx";
    getInitialData?: ((req: IRequest<Session<any>>) => {
        [key: string]: any;
    } | Promise<{
        [key: string]: any;
    }>);
    getTitle?: ((req: IRequest<Session<any>>) => string | Promise<string>);
    jsDir?: string;
    layoutComponent?: typeof Layout;
    locale?: {
        accepted?: string[];
        default?: string;
    };
    logging?: boolean;
    mergeStyles?: string[];
    onWebpackProgress?: ((percents: number, message: string) => void);
    port?: number;
    rsConfig?: string;
    scripts?: string[];
    session?: typeof Session;
    socketIO?: ServerOptions;
    socketMessageMaxSize?: number;
    sourceStylesDir?: string;
    staticDir?: string;
    styles?: string[];
    tsCompilerOptions?: CompilerOptions;
    webpack?: any;
}

Properties

appDir? auth? autoprefixer? babelTranspileModules? bundleAfterServerStart? bundlePathRelative? connectSocketAutomatically? cookies? cookieSecret? createMissingComponents? cssDir? dev? entryFile? envVars? error? errorHandler? filename? generatedComponentsExtension? getInitialData? getTitle? jsDir? layoutComponent? locale? logging? mergeStyles? onWebpackProgress? port? rsConfig? scripts? session? socketIO? socketMessageMaxSize? sourceStylesDir? staticDir? styles? tsCompilerOptions? webpack?

Properties

OptionalappDir

appDir?: string

Relative path to the app directory.

Default

'./app'

Optionalauth

auth?: ((session: Session<any>, next: ((err?: any) => void)) => void)

Auth function called before the route execution.

Type declaration

    • (session, next): void

    • Parameters

      • session: Session<any>

        Session instance.

      • next: ((err?: any) => void)
          • (err?): void

          • Parameters

            • Optionalerr: any

            Returns void

      Returns void

Default

(session, next) => next()

Optionalautoprefixer

autoprefixer?: any

Custom autoprefixer config.

Default

{}

OptionalbabelTranspileModules

babelTranspileModules?: string[]

List of modules to add to the babel-loader.

Default

[]

OptionalbundleAfterServerStart

bundleAfterServerStart?: boolean

Indicates if the server should be started before the webpack bundle. In that case bundling info page is rendered. @default: false

OptionalbundlePathRelative

bundlePathRelative?: boolean

Indicates if the bundle is loaded relatively in the output html.

Default

false

OptionalconnectSocketAutomatically

connectSocketAutomatically?: boolean

Indicates if the socket should be connected automatically after the bundle load.

Default

true

Optionalcookies

cookies?: {
    domain?: string;
    httpOnly?: boolean;
    sameSite?: string;
    secret?: string;
    secure?: boolean;
}

Configuration for cookies.

Type declaration

  • Optionaldomain?: string

    The domain flag for the cookies.

    Default

    null
  • OptionalhttpOnly?: boolean

    HttpOnly flag for the cookies.

    Deprecated

    The flag should be always true.

    Default

    null
  • OptionalsameSite?: string

    SameSite flag for the cookies.

    Default

    null
  • Optionalsecret?: string

    Secret which is used to sign cookies.

    Default

    '[random generated string]'
  • Optionalsecure?: boolean

    Secure flag for the cookies.

    Default

    null

OptionalcookieSecret

cookieSecret?: string

Secret which is used to sign cookies.

Default

null

Deprecated

OptionalcreateMissingComponents

createMissingComponents?: boolean

Indicates if registered components should be created if missing.

Default

false

OptionalcssDir

cssDir?: string

Name of the directory where the css is located in the staticDir.

Default

'css'

Optionaldev

dev?: boolean

Flag of the dev status of the app.

Default

false

OptionalentryFile

entryFile?: string

Relative path to the entry file.

Default

null

OptionalenvVars

envVars?: Record<string, any>

Client env variables.

Optionalerror

error?: {
    handler?: (<S>(err: any, req: IRequest<S>, res: IResponse, next: ((err?: any) => void)) => void);
    layout?: typeof Layout;
    page?: any;
}

Definition of error handling

Type declaration

  • Optionalhandler?: (<S>(err: any, req: IRequest<S>, res: IResponse, next: ((err?: any) => void)) => void)

    Function to handle errors in the route execution.

    Default

    (err, req, res, next) => next()
      • <S>(err, req, res, next): void

      • Type Parameters

        Parameters

        • err: any
        • req: IRequest<S>
        • res: IResponse
        • next: ((err?: any) => void)
            • (err?): void

            • Parameters

              • Optionalerr: any

              Returns void

        Returns void

  • Optionallayout?: typeof Layout

    Error layout.

  • Optionalpage?: any

    Error page.

OptionalerrorHandler

errorHandler?: (<S>(err: any, req: IRequest<S>, res: IResponse, next: ((err?: any) => void)) => void)

Function to handle errors in the route execution.

Default

(err, req, res, next) => next()

Deprecated

Optionalfilename

filename?: string

Name of the bundle file.

Default

'bundle.js'

OptionalgeneratedComponentsExtension

generatedComponentsExtension?:
    | "js"
    | "jsx"
    | "ts"
    | "tsx"

Extension of the generated components.

Default

'tsx'

OptionalgetInitialData

getInitialData?: ((req: IRequest<Session<any>>) => {
    [key: string]: any;
} | Promise<{
    [key: string]: any;
}>)

Gets the request initial data.

OptionalgetTitle

getTitle?: ((req: IRequest<Session<any>>) => string | Promise<string>)

Gets the request title.

OptionaljsDir

jsDir?: string

Name of the directory where the javascript is located in the staticDir.

Default

'js'

OptionallayoutComponent

layoutComponent?: typeof Layout

React component width default html code.

Default

typeof Layout

Optionallocale

locale?: {
    accepted?: string[];
    default?: string;
}

Locale settings.

Type declaration

  • Optionalaccepted?: string[]

    List of accepted locales.

    Default

    []
  • Optionaldefault?: string

    Default locale of the website. This locale will be used in default.json.

    Default

    'en-US'

Optionallogging

logging?: boolean

Indicates if the server logs to the console.

Default

true

OptionalmergeStyles

mergeStyles?: string[]

List of styles to merge to rs-app.css.

Default

[]

OptionalonWebpackProgress

onWebpackProgress?: ((percents: number, message: string) => void)

Function to handle webpack progress.

Default

null

Optionalport

port?: number

Port on which the app listens.

Default

8080

OptionalrsConfig

rsConfig?: string

Custom path to rsconfig.json file.

Default

null

Optionalscripts

scripts?: string[]

List of scripts loaded in the base html.

Default

[]

Optionalsession

session?: typeof Session

Class of the session.

Default

typeof Session

OptionalsocketIO

socketIO?: ServerOptions

Custom socketIO config.

Default

{}

OptionalsocketMessageMaxSize

socketMessageMaxSize?: number

Maximal size of one socket message.

Default

104857600

OptionalsourceStylesDir

sourceStylesDir?: string

Path to the directory containing source styles that are merged to app styles.

Default

'./[staticDir]/[cssDir]'

OptionalstaticDir

staticDir?: string

Relative path to the static directory for the express app.

Default

'./public'

Optionalstyles

styles?: string[]

List of styles loaded in the base html.

Default

[]

OptionaltsCompilerOptions

tsCompilerOptions?: CompilerOptions

Additional TS compiler options.

Optionalwebpack

webpack?: any

Custom webpack config.

Default

{}

Settings

Member Visibility

On This Page

Properties