For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/rspeedy/rspeedy.defineconfig_1.md.
Rspeedy logo
Rspeedy
  • English

      • Home > @lynx-js/rspeedy > defineConfig

      defineConfig() function

      The defineConfig method is a helper function used to get TypeScript intellisense.

      Signature:

      export declare function defineConfig(config: (params: ConfigParams) => Config): (params: ConfigParams) => Config;

      Parameters

      Parameter

      Type

      Description

      config

      (params: ConfigParams) => Config

      The function that returns a config of Rspeedy.

      Returns:

      (params: ConfigParams) => Config

      • The identical function as the input.

      Example 1

      Use defineConfig in lynx.config.ts:

      import { defineConfig } from '@lynx-js/rspeedy'
export default defineConfig(() => {
  return {
    // autocompletion works here!
  }
})

      Example 2

      Use defineConfig with parameters in lynx.config.ts:

      import { defineConfig } from '@lynx-js/rspeedy'

export default defineConfig(({ env }) => {
  const isTest = env === 'test'
  return {
    output: {
      minify: isTest ? false : true,
    },
  }
})
      Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.