Specify that data object can be null

[hyunbinseo]

Improve documentation

Link

Typescript Support

supabase-js always returns a data object (for success), and an error response (for unsuccessful requests).

Describe the problem

Prefer: return=minimal is set by default now.

• feat: set Prefer: return=minimal by default postgrest-js#276

Therefore, if .select() is not chained, successful requests return null for both data and error.

Describe the improvement

Current documentation is technically correct - successful requests do return data object of null or an array.

However, being more explicit would not hurt.

supabase-js always returns a data array (for successful requests with .select() chained) …

Additional context

The following code will always throw an error for both successful and unsuccessful requests.

const { data, error } = await supabase
  .from('countries')
  .insert({ id: 1, name: 'Denmark' });

if (!data || error) throw new Error();

Successful responses used to return an data array, so the above code was valid in v1.

• Major DX change: response and error handling  supabase-js#32

[GaryAustin1]

I believe in the case of .maybeSingle a .select() will also return null for 0 rows matched.

[charislam]

Closing as the Typescript support documentation has changed significantly and typing support should be better now