Supabase will soon release native type generators that dump your database types for various languages. For now, we support TypeScript through a third-party tool.
Usage with TypeScript
supabase-js ships with type definitions for usage with TypeScript and for convenient IntelliSense auto-complete and documentation in your editor.
When using TypeScript, you can pass the type of database row as a type parameter to the
from method to get better auto-completion support down the chain.
If you don't provide a type for the row you need to explicitly pass
Generate database types from OpenAPI specification
Supabase generates a OpenAPI specification file for your database which can be used to generate your data types for usage with TypeScript.
The OpenAPI specification for your Supabase project can be accessed as follows:
Using the open source openapi-typescript tool you can generate your types and store them locally:
Note: Do note that your local types won't automatically stay in sync with your database, so make sure to regenerate your types after your make changes to your database.
After you have generated your types, you can use them in your TypeScript projects: