프로그래매틱 사용
Nuxt Kit은 Nuxt를 프로그래매틱하게 작업할 수 있도록 돕는 유틸리티 세트를 제공합니다. 이 함수들은 Nuxt를 로드하고, Nuxt를 빌드하며, Nuxt 설정을 로드할 수 있게 해줍니다.
프로그래매틱 사용은 예를 들어 CLI 도구나 테스트 유틸리티를 빌드할 때 Nuxt를 프로그래매틱하게 사용하고자 할 때 유용할 수 있습니다.
loadNuxt
Nuxt를 프로그래매틱하게 로드합니다. Nuxt 설정을 로드하고, 인스턴스를 생성하며 Nuxt 인스턴스와 함께 프라미스를 반환합니다.
타입
function loadNuxt (loadOptions?: LoadNuxtOptions): Promise<Nuxt>
매개변수
loadOptions
: Nuxt의 로딩 조건입니다. loadNuxt
는 내부적으로 c12
를 사용하므로, c12.loadConfig
와 동일한 옵션을 일부 추가 옵션과 함께 허용합니다:
속성 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
dev | boolean | false | true 로 설정하면 Nuxt가 개발 모드로 로드됩니다. |
ready | boolean | true | true 로 설정하면 loadNuxt 호출 후 Nuxt가 사용할 준비가 됩니다. false 로 설정하면 Nuxt가 사용할 준비가 되었는지 확인하기 위해 nuxt.ready() 를 호출해야 합니다. |
buildNuxt
Nuxt를 프로그래매틱하게 빌드합니다. 애플리케이션을 번들링하기 위해 빌더(현재 @nuxt/vite-builder 또는 @nuxt/webpack-builder)를 호출합니다.
타입
function buildNuxt (nuxt: Nuxt): Promise<any>
매개변수
nuxt
: 빌드할 Nuxt 인스턴스입니다. useNuxt()
호출을 통해 컨텍스트에서 가져올 수 있습니다.
loadNuxtConfig
Nuxt 설정을 로드합니다. 설정 객체와 함께 프라미스를 반환합니다.
타입
function loadNuxtConfig (options: LoadNuxtConfigOptions): Promise<NuxtOptions>
매개변수
options
: c12
loadConfig
호출에 전달할 옵션입니다.
writeTypes
tsconfig.json
을 생성하고 프로젝트의 buildDir에 작성합니다.
타입
function writeTypes (nuxt?: Nuxt): void
매개변수
nuxt
: 빌드할 Nuxt 인스턴스입니다. useNuxt()
호출을 통해 컨텍스트에서 가져올 수 있습니다.
※이 페이지는 Nuxt.js 공식 문서의 비공식 번역 페이지입니다.
공식 문서의 해당 페이지는 여기 있습니다:
https://nuxt.com/docs/3.x/api/kit/programmatic