Type alias AgentOptions

AgentOptions: {
    authSecret: string;
    bodyParserOptions?: {
        enableRawChecking?: boolean;
        jsonLimit?: number | string;
    };
    customizeErrorMessage?: ((error: Error) => string | null) | null;
    envSecret: string;
    experimental?: {
        updateRecordCustomActions?: boolean;
        webhookCustomActions?: boolean;
    };
    forestAdminClient?: ForestAdminClient;
    forestServerUrl?: string;
    ignoreMissingSchemaElementErrors?: boolean;
    instantCacheRefresh?: boolean;
    isProduction: boolean;
    limitExportSize?: number;
    logger?: Logger;
    loggerLevel?: LoggerLevel;
    maxBodySize?: string;
    permissionsCacheDurationInSeconds?: number;
    prefix?: string;
    schemaPath?: string;
    skipSchemaUpdate?: boolean;
    typingsMaxDepth?: number;
    typingsPath?: string | null;
    useUnsafeActionEndpoint?: boolean;
}

Options to configure behavior of an agent's forestadmin driver

Type declaration

  • authSecret: string
  • Optional bodyParserOptions?: {
        enableRawChecking?: boolean;
        jsonLimit?: number | string;
    }

    Refer to @koa/bodyparser options

    Link

    https://github.com/koajs/bodyparser?tab=readme-ov-file#options

    • Optional enableRawChecking?: boolean
    • Optional jsonLimit?: number | string
  • Optional customizeErrorMessage?: ((error: Error) => string | null) | null
  • envSecret: string
  • Optional experimental?: {
        updateRecordCustomActions?: boolean;
        webhookCustomActions?: boolean;
    }
    • Optional updateRecordCustomActions?: boolean
    • Optional webhookCustomActions?: boolean
  • Optional forestAdminClient?: ForestAdminClient
  • Optional forestServerUrl?: string
  • Optional ignoreMissingSchemaElementErrors?: boolean

    If true, the agent will not throw an error when a customization error occurs, because of a missing collection for example.

    Default

    false

  • Optional instantCacheRefresh?: boolean
  • isProduction: boolean
  • Optional limitExportSize?: number
  • Optional logger?: Logger
  • Optional loggerLevel?: LoggerLevel
  • Optional maxBodySize?: string

    Deprecated

    use bodyParserOptions.jsonLimit instead.

    Todo

    remove option

  • Optional permissionsCacheDurationInSeconds?: number
  • Optional prefix?: string
  • Optional schemaPath?: string
  • Optional skipSchemaUpdate?: boolean
  • Optional typingsMaxDepth?: number
  • Optional typingsPath?: string | null
  • Optional useUnsafeActionEndpoint?: boolean

Settings

Member Visibility

Theme