`toSerializable()` makes column types {orginal_type} | undefined

maxfiOP•2/19/24, 4:09 AM

Note that the descriptiondescription type is StringString and not nullnot null. After calling toSerializable()toSerializable() on the record the type is

string | undefined

string | undefined

maxfiOP•2/19/24, 6:03 AM

My current workaround. I'm not really a fan of using typescript's

as

as

. Hope there is a better solution.

maxfiOP•2/19/24, 6:07 AM

maxfiOP•2/19/24, 6:10 AM

Also, ideally I'd like to be able to avoid the

map

map

to fix the types (including the productIdproductId being string | null | undefinedstring | null | undefined

kostas•2/19/24, 10:19 AM

Hello, the purpose of the toSerializabletoSerializable method is to convert content to plain JSON so it can be passed to the client, where the JSONDataJSONData helper function restores the original types.

You can find a reference here: https://xata.io/docs/sdk/typescript/overview#serializing-xata-data-structures

Have you tried JSONData, or is there some other reason why you're needing to fix up the types this way?

maxfiOP•2/21/24, 10:39 AM

Hi @kostas. Thanks for getting back to me.

Yeah, I need to serialize the data to be able to return it from a next.js api route that gets used on the client with react-queryreact-query. I need to serialize it remove the xata functions, otherwise next.js throws errors.

maxfiOP•2/21/24, 10:40 AM

I've tried the JSONDataJSONData helper but all the columns end up being optional. Ie, null | undefinednull | undefined is being added to the type of each column.

kostas•2/22/24, 9:04 AM

I think this might call for an enhancement for the JSONDataJSONData helper to consider the column constraints (such as notNull) when adding back the types. Would you mind opening an issue in the open source client-ts repo for our SDK team to review? https://github.com/xataio/client-ts/issues I can do it on your behalf, let me know!

GitHub

Issues · xataio/client-ts

Xata.io SDK for TypeScript and JavaScript. Contribute to xataio/client-ts development by creating an account on GitHub.

maxfiOP•2/22/24, 11:38 AM

Thanks @kostas. Yup, I'll try to get that done tomorrow.

maxfiOP•3/15/24, 7:23 AM

Hi @kostas. I've created the issue https://github.com/xataio/client-ts/issues/1410. Thanks.

GitHub

Issues · xataio/client-ts

Xata.io SDK for TypeScript and JavaScript. Contribute to xataio/client-ts development by creating an account on GitHub.

kostas•3/15/24, 7:27 AM

Great, I'll bring it to the dev team's attention. Thanks for the clear description! We'll let you know if anything else is needed.

maxfiOP•3/15/24, 7:33 AM

Awesome! Thanks @kostas!

Bill.IHCha•11/1/24, 6:18 AM

is this ever going to be fixed?

`toSerializable()` makes column types {orginal_type} | undefined

Similar Threads

Similar Threads

Similar Threads