• 简体中文

      • 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) => Promise<Config>): (params: ConfigParams) => Promise<Config>;

      Parameters

      ParameterTypeDescription
      config(params: ConfigParams) => Promise<Config>The function that returns a promise that resolves to a config of Rspeedy.

      Returns:

      (params: ConfigParams) => Promise<Config>

      • The identical function as the input.

      Example 1

      Use defineConfig in lynx.config.ts:

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

      Example 2

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