Document how to query products (other entities) by custom fields

Is your feature request related to a problem? Please describe. When implementing API extensions or other custom logic - there may come need to “find” Products or other entities by one of Custom Fields.

Let’s say I have custom field Product.customFields.visible (boolean). And I want all products where visible = true

Describe the solution you’d like Improve documentation to include example how to do this:

My example

const results = await connection.getRepository(Product)
    .createQueryBuilder('product')
    .where('product.customFieldsVisible = true')
    .getMany()

Additional context I will be happy to submit PR just need to know where it would fit the best / in which form. Or maybe its already somewhere and I just missed it?

[michaelbromley]

Hi, This is a good idea, but I don’t think there is an obviously correct place in the docs for this right now, which would be easy to locate.

It might be worth creating a “TypeORM Recipes” page which lists all the most common scenarios that might be difficult/non-obvious when developing plugins. This might fit well in the Plugins > Plugin Examples docs section.

We could include for starters:

• Select by customField value (your example)
• … by localeString customField
• … by relation customField
• Selecting translatable entities using translateDeep()
• Creating PaginatedList responses using ListQueryBuilder

[michaelbromley]

Unfortunately not. I moved the website into a separate (private) repo. But mostly its just regular markdown which any markdown editor should render well enough.