[TypeScript] supabase에서 테이블 타입 가져오기

RingKim1·2024년 7월 25일
post-thumbnail

타입 스크립트를 사용하면 타입을 일일이 지정해줘야 하는 번거로움이 있는
supabase를 쓰게되면 해당 테이블에 맞는 타입을 가져올 수 있는 방법이 있어서 짧게 기록


방법

1. pakage.json 열고 스크립트 부분에 추가

//pakage.json
  "scripts": {
    "genTypes": "npx supabase gen types --lang=typescript --project-id "$PROJECT_REF" --schema public > src/types/supabase.ts"
  }

⚠️$PROJECT_REF 는 자신의 supbase Project URL에서 찾을 수 있음


✔️2~5번은 터미널에서 코드 입력

2. supabase CLI 설치

  • npm
npm i supabase@">=1.8.1" --save-dev
  • yarn
yarn add supabase@">=1.8.1" --save-dev

3. npx supabase login

npx supabase login

4. npx supabase init

npx supabase init

5. genTypes 명령어 입력

명령어를 입력하고 타입을 가져오면 끝

  • npm
npm run genTypes
  • yarn
yarn genTypes

사용

Using TypeScript type definitions#

import { createClient } from '@supabase/supabase-js'
import { Database } from './database.types'

const supabase = createClient<Database>(process.env.SUPABASE_URL, process.env.SUPABASE_ANON_KEY)

공식문서

profile
커피는 콜드브루

0개의 댓글