#Function: defineConfig()

#Call Signature

defineConfig(config: Config): Config

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

#Parameters

#Returns

Config

The identical config as the input config.

#Example

Use defineConfig in lynx.config.ts:

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

#Call Signature

defineConfig(config: (params: ConfigParams) => Config): (params: ConfigParams) => Config

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

#Parameters

#Returns

The identical function as the input.

(params: ConfigParams) => Config

#Examples

Use defineConfig in lynx.config.ts:

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

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,
    },
  }
})

#Call Signature

defineConfig(config: Promise<Config>): Promise<Config>

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

#Parameters

#Returns

Promise<Config>

The identical promise as the input.

#Example

Use defineConfig in lynx.config.ts:

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

export default defineConfig(
  import('@lynx-js/react-rsbuild-plugin').then(({ pluginReactLynx }) => ({
    plugins: [pluginReactLynx()],
  })),
);

#Call Signature

defineConfig(config: (params: ConfigParams) => Promise<Config>): (params: ConfigParams) => Promise<Config>

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

#Parameters

#Returns

The identical function as the input.

(params: ConfigParams) => Promise<Config>

#Examples

Use defineConfig in lynx.config.ts:

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

Use defineConfig with parameters in lynx.config.ts:

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

export default defineConfig(async ({ env }) => {
  const foo = await bar()
  const isTest = env === 'test'
  return {
    output: {
      minify: isTest ? false : true,
    },
  }
})