#community-help

Auto-generating Typesense Collection Types with TypeScript

TLDR Udo asked about auto-generating types using schema definitions in Typesense. Jason clarified the limitations and suggested defining types manually. Udo agreed to add TypeScript notes to README.

7mo

Join the chat

Mar 21, 2023 (7 months ago)

Photo of md5-cabbd7b73bbc9bdf14391445a8d5890c

Udo

09:22 AM

to clarify, I did manage to create custom types that I can pass into collections (collections<SomethingType>('something')) but I was hoping there would be some sort of way to auto-generate these from the schema definition

Photo of md5-4e872368b2b2668460205b409e95c2ea

Kishore Nallan

09:37 AM

cc Jason

Photo of md5-8813087cccc512313602b6d9f9ece19f

Jason

03:35 PM

Udo The collection schema type that Typesense uses has metadata fields in it, that your document will not have. Also the Typesense schema can also change dynamically on the Typesense server side. This is why it’s hard to rely on the collection schema to generate the type for your document

03:36

Jason

03:36 PM

In any case, the assumption is that you already have a type defined for your document, and you can pass that into the Typesense library like you’ve mentioned above

Udo

04:10 PM

Jason thanks for clarifying. I guess I'm just spoiled from using prisma 😉 I understand it's not the same thing and has some caveats...The lack of documentation just made me doubt if I'm missing something here. A short note about working with typescript in the README would be very helpful for newcomers

Jason

04:11 PM

I’m not a Typescript expert myself, so if you want to add a note to the README in a PR about how to use with Typescript, that would be awesome!

Udo

04:11 PM

sure thing

Typesense

Lightning-fast, open source search engine for everyone | Knowledge Base powered by Struct.AI

Indexed 2786 threads (79% resolved)

Join Our Community Manage subscription

Similar Threads

Fixing "bad json" error in Typesense 0.24

Adam experiences "bad json" error when creating collections in Typesense 0.24. Jason identifies a typo in the docs causing the error and helps troubleshoot additional errors.

7mo

Complex Query System and Collections Schema for Typesense

Orion asks about the grammar for 'filter_by' search parameters and where to find a collections schema. Jason provides the needed documentation and encourages Orion to share back.

3mo

Resolving Typesense Error for Invalid Field Types

Edward was facing a problem sending documents due to invalid field types. Jason helped to identify and resolve the issued by advising on the correct usage of the schema.

18mo